Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
S
 selector, MessageChannel
 send
InetMessageChannelInmHelperMessageChannelRoutingMessageChannelSerialMessageChannel
 send_mval, InmHelper
 sendrecv, InmHelper
 sendrecv_mval, InmHelper
 SerialMessageChannel
 set_format_val_conv, MessageFactory
 set_format_val_size, MessageFactory
 set_make_val_int_size, MessageFactory
 set_timeout
InetMessageChannelMessageChannelRoutingMessageChannelSerialMessageChannel
 srcadr
MessageChannelMessageHeader
 SRCADR_SIZE, MessageHeader
 StandardMessage
 StandardRegisters
 StandardResults
 StandardTypes
 STDERR, StandardRegisters
 STDIN, StandardRegisters
 STDIO, StandardRegisters
 STDIO_H, StandardRegisters
 STDIO_L, StandardRegisters
 STDIOERR, StandardRegisters
 STDIOERR_H, StandardRegisters
 STDIOERR_L, StandardRegisters
 STDOUT, StandardRegisters
 Str, ValueConversions
 str_encoding, MessageFactory
 str_val_conv, MessageFactory
 Strictness
 SUCCESS, ResultCode
T
 tcp_port, InetMessageChannel
 timeout, MessageChannel
 TIMEOUT_DIVISOR
RoutingMessageChannelSerialMessageChannel
 to_bytes
MessageMessageHeader
 Tuple, ValueConversions
 typ, Message
 Typ, InmHelper
 TYPE, StandardResults
 type_enum_class, MessageFactory
U
 udp_port, InetMessageChannel
 UNROUTABLE, ResultCode
 Utility Functions
V
 val, Message
 ValueConversions
 Variables
GlobalInetMessageChannelInmHelperLargeMessageMessageMessageChannelMessageFactoryMessageHeaderRoutingMessageChannelSerialMessageChannelStandardMessage
 VC, InmHelper
Z
 ZERO_DURATION
self.selector
A selector object compatible with the ones provided by the standard library module selectors.
def send(self,  
dstadr,  
msg,  
msg_id = None,
srcadr = None,
link_adr = None)
Implements MessageChannel.send.
def send(self,  
dstadr,  
typ,  
val,  
int_size = None,
msg_id = None,
srcadr = None,
link_adr = None)
Constructs and sends an INM message.
def send(self,  
dstadr,  
msg,  
msg_id = None,
srcadr = None,
link_adr = None)
Sends an INM message.
def send(self,  
dstadr,  
msg,  
msg_id = None,
srcadr = None,
link_adr = None,
in_link_adr = None,
envelope_dstadr = None,
send_cc = True)
Implements MessageChannel.send.
def send(self,  
dstadr,  
msg,  
msg_id = None,
srcadr = None,
link_adr = None)
Implements MessageChannel.send.
def send_mval(self,  
dstadr,  
typ,  
mval,  
int_size = None,
msg_id = None,
srcadr = None,
link_adr = None)
Constructs and sends an INM message with a multipart message value.
def sendrecv(self,  
dstadr,  
typ,  
val,  
int_size = None,
msg_id = None,
srcadr = None,
link_adr = None)
First constructs and sends an INM message, then attempts to receive one.
def sendrecv_mval(self,  
dstadr,  
typ,  
mval,  
int_size = None,
msg_id = None,
srcadr = None,
link_adr = None)
First constructs and sends an INM message with a multipart value, then attempts to receive a message.
class SerialMessageChannel(BinaryMessageChannel)
A BinaryMessageChannel that sends and receives messages via a serial port.
def set_format_val_conv(self,
tlv_type,
conv)
Sets the value formatting conversion specifier associated with a specified message type.
def set_format_val_size(self,
tlv_type,
size)
Sets the value formatting field sizes associated with a specified message type.
def set_make_val_int_size(self,
tlv_type,
int_size)
Sets the value construction integer field sizes associated with a specified message type.
def set_timeout(self,
timeout)
Overrides MessageChannel.set_timeout.
def set_timeout(self,
timeout)
Updates the timeout attribute.
def set_timeout(self,
timeout)
Overrides MessageChannel.set_timeout.
def set_timeout(self,
timeout)
Overrides MessageChannel.set_timeout.
self.srcadr
Default INM source address of messages sent via this MessageChannel.
self.srcadr
Source INM node address.
SRCADR_SIZE = 1
Size in bytes of the source address field in an INM message header.
class StandardMessage(Message)
Concrete Message subclass for standard-size INM messages.
Standard INM register identifiers.
Standard INM result codes.
Standard INM message types.
Error/debug output stream register.
Standard input stream register.
Standard I/O stream register.
Upper half of 16-bit standard I/O stream register pair.
Alias of STDIO.
Error/debug I/O stream register.
Upper half of 16-bit error/debug I/O stream register pair.
Alias of STDIOERR.
Standard output stream register.
Decoded text string
self.str_encoding
Name of text encoding to use when making and formatting message values.
self.str_val_conv
Conversion for string-formatted message values.
Multipart formatting strictness specifiers for INM message values.
Operation successfully completed.
self.tcp_port
Port number of TCP socket used by this InetMessageChannel.
self.timeout
Receive timeout.
TIMEOUT_DIVISOR = 10.0
If a receive timeout is set on a RoutingMessageChannel, the timeout set on each of the recv_channels will be the primary timeout divided by TIMEOUT_DIVISOR times the number of receive channels.
TIMEOUT_DIVISOR = 10.0
If a receive timeout is set on a SerialMessageChannel, the timeout set for each attempt to read data from the underlying serial port API will be the primary timeout divided by TIMEOUT_DIVISOR.
def to_bytes(self,  
formatter = None)
Converts the Message to a bytes object containing the message in standard binary on-wire format.
def to_bytes(self,  
formatter = None)
Converts the MessageHeader to a bytes object containing the header in standard binary on-wire format.
Tuple of byte values (as integers)
self.typ
Message type identifier.
Typ = inm.StandardTypes
Shorthand alias of StandardTypes.
Error: Unrecognized message type.
self.type_enum_class
Enum class to use for conversion of message type identifiers.
self.udp_port
Port number of UDP socket used by this InetMessageChannel.
Message could not be routed toward destination.
self.val
Message value/payload.
Type conversion specifiers for INM message values.
VC = inm.ValueConversions
Shorthand alias of ValueConversions.
ZERO_DURATION = datetime.timedelta()
A datetime.timedelta representing a zero duration.
Close