G | |
get_format_val_conv, MessageFactory | |
get_format_val_size, MessageFactory | |
get_make_val_int_size, MessageFactory | |
get_next_msg_id, MessageChannel | |
get_selector_keys | |
get_timedelta | |
H | |
header_to_bytes, InmHelper | |
header_to_hex, InmHelper | |
I | |
interactive | |
is_open | |
M | |
make_large_msg, MessageFactory | |
make_large_msg_mval, MessageFactory | |
make_msg, MessageFactory | |
make_msg_mval, MessageFactory | |
make_mval, MessageFactory | |
make_val, MessageFactory | |
map_enum | |
msg_to_bytes | |
msg_to_bytes_mval, InmHelper | |
msg_to_hex, InmHelper | |
msg_to_hex_mval, InmHelper | |
O | |
open | |
P | |
peek_next_msg_id, MessageChannel | |
peek_prev_msg_id, MessageChannel | |
R | |
readable, MessageChannel | |
recv | |
remove_cc_adr, RoutingMessageChannel | |
route, RoutingMessageChannel |
Gets the value formatting conversion specifier associated with a specified message type.
def get_format_val_conv( self, tlv_type, default = None )
Gets the value formatting field sizes associated with a specified message type.
def get_format_val_size( self, tlv_type, default = None )
Gets the value construction integer field sizes associated with a specified message type.
def get_make_val_int_size( self, tlv_type, default = None )
Auto-generates an INM message ID.
def get_next_msg_id( self )
Returns the selector key of the UDP socket.
def get_selector_keys( self )
Gets the selector keys of encapsulated selectable objects from this MessageChannel.
def get_selector_keys( self )
Returns all selector keys obtained by calling the get_selector_keys methods of the channels in recv_channels.
def get_selector_keys( self )
Returns the selector key of the serial port device.
def get_selector_keys( self )
Produces a datetime.timedelta with a specified duration.
def get_timedelta( secs = 0, musecs = 0 )
Constructs an INM message header and returns it as a bytes object.
def header_to_bytes( self, dstadr, msg_id = None, srcadr = None )
Constructs an INM message header and returns it as a list of hex strings.
def header_to_hex( self, dstadr, msg_id = None, srcadr = None )
Creates an InmHelper and configures it for use in an interactive Python session.
def interactive( channel = None, msg_factory = None, srcadr = None, ip_adr = None, udp_port = None, tcp_port = None, timeout = 1, link_adr = None )
Checks whether the InmHelper is open.
def is_open( self )
Checks whether the MessageChannel is open.
def is_open( self )
Constructs a large INM Message with the specified type and value.
def make_large_msg( self, typ, val, int_size = None )
Constructs a large INM Message with the specified type and multipart value.
def make_large_msg_mval( self, typ, mval, int_size = None )
Constructs an INM Message with the specified type and value.
def make_msg( self, typ, val, int_size = None )
Constructs an INM Message with the specified type and multipart value.
def make_msg_mval( self, typ, mval, int_size = None )
Creates a bytes object containing a multipart INM message value.
def make_mval( self, mval, int_size = None, tlv_type = None )
Creates a bytes object containing an INM message value.
def make_val( self, val, int_size = None, tlv_type = None )
Searches an enum class for a member with a specified integer value.
def map_enum( enum_class, i, defval = None )
Constructs an INM message and returns it as a bytes object.
def msg_to_bytes( self, dstadr, typ, val, int_size = None, msg_id = None, srcadr = None, with_header = True )
Converts a Message and MessageHeader to a bytes object containing the message and header in standard binary on-wire format.
def msg_to_bytes( self, msg, header = None )
Constructs an INM message with a multipart message value and returns it as a bytes object.
def msg_to_bytes_mval( self, dstadr, typ, mval, int_size = None, msg_id = None, srcadr = None, with_header = True )
Constructs an INM message and returns it as a list of hex strings.
def msg_to_hex( self, dstadr, typ, val, int_size = None, msg_id = None, srcadr = None, with_header = True )
Constructs an INM message with a multipart message value and returns it as list of hex strings.
def msg_to_hex_mval( self, dstadr, typ, mval, int_size = None, msg_id = None, srcadr = None, with_header = True )
Overrides MessageChannel.open.
def open( self )
Opens the encapsulated channel.
def open( self )
Opens the MessageChannel.
def open( self )
Overrides MessageChannel.open.
def open( self )
Overrides MessageChannel.open.
def open( self )
Peeks at the next INM message ID to be auto-generated.
def peek_next_msg_id( self )
Peeks at the most recently auto-generated INM message ID.
def peek_prev_msg_id( self )
Checks whether the MessageChannel is readable.
def readable( self )
Implements MessageChannel.recv.
def recv( self )
Attempts to receive an INM message.
def recv( self )
Attempts to receive an INM message.
def recv( self )
Implements MessageChannel.recv.
def recv( self )
Implements MessageChannel.recv.
def recv( self )
Removes the INM address of a CC message destination node from cc_to.
def remove_cc_adr( self, cc_adr )
Attempts to receive and then route an INM message.
def route( self )