Variable 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
B
 BROADCAST_ADR, MessageHeader
D
 DEFAULT_BAUDRATE, SerialMessageChannel
 DEFAULT_CH_TIMEOUT, RoutingMessageChannel
 DEFAULT_IP_ADR
 DEFAULT_LINK_UDP_PORT, InmHelper
 default_msg_factory
 DEFAULT_REG_ENUM_MSG_TYPES, MessageFactory
 DEFAULT_RES_ENUM_MSG_TYPES, MessageFactory
 DEFAULT_SRCADR, InmHelper
 DEFAULT_TCP_PORT, InetMessageChannel
 DEFAULT_UDP_PORT
 DSTADR_SIZE, MessageHeader
G
 get_timestamp
H
 HEADER_SIZE, MessageHeader
L
 LOCAL_ADR, MessageHeader
M
 make_default_selector, MessageChannel
 MAKE_VAL_ATTR_NAME, MessageFactory
 MAX_DATAGRAM_SIZE, InetMessageChannel
 MAX_MESSAGE_ADR, MessageHeader
 MAX_MESSAGE_ID, MessageHeader
 MAX_MESSAGE_LEN
 MAX_TYPE_NUM
 MESSAGE_ID_SIZE, MessageHeader
 MESSAGE_LEN_SIZE
 MESSAGE_TYP_SIZE, Message
 MIN_MESSAGE_SIZE
 MIN_TYPE_NUM
N
 N_HEADER_BYTES, SerialMessageChannel
P
 PROTOCOL_TYPE_NUM, StandardMessage
R
 RC, InmHelper
 Reg, InmHelper
 Res, InmHelper
S
 SRCADR_SIZE, MessageHeader
T
 TIMEOUT_DIVISOR
 Typ, InmHelper
V
 VC, InmHelper
Z
 ZERO_DURATION
BROADCAST_ADR = MAX_MESSAGE_ADR
Reserved INM node address for broadcast messages.
DEFAULT_BAUDRATE = 38400
Default baud rate to set on the opened serial port.
DEFAULT_CH_TIMEOUT = get_timedelta(musecs = 10000)
If no receive timeout is set on a RoutingMessageChannel, then the timeout set on each of the recv_channels will be DEFAULT_CH_TIMEOUT.
DEFAULT_IP_ADR = '127.0.0.1'
Default IP socket address.
DEFAULT_IP_ADR = '127.0.0.1'
Default IP address of internal InetMessageChannel.
DEFAULT_LINK_UDP_PORT = 3000
Default target UDP port of internal InetMessageChannel.
default_msg_factory = MessageFactory()
A default instance of MessageFactory.
DEFAULT_REG_ENUM_MSG_TYPES = (StandardTypes.REG_READ,
StandardTypes.REG_READ_RES,
StandardTypes.INM_REG_READ_RES,
StandardTypes.REG_WRITE,
StandardTypes.REG_TOGGLE,
StandardTypes.REG_RW_EXCH,
StandardTypes.REG_WR_EXCH,
StandardTypes.REGPAIR_READ,
StandardTypes.REGPAIR_READ_RES,
StandardTypes.INM_REGPAIR_READ_RES,
StandardTypes.REGPAIR_WRITE,
StandardTypes.REGPAIR_TOGGLE,
StandardTypes.REGPAIR_RW_EXCH,
StandardTypes.REGPAIR_WR_EXCH)
Default message types for register identifier enum conversion.
DEFAULT_RES_ENUM_MSG_TYPES = (StandardTypes.RESULT,
StandardTypes.INM_RESULT)
Default message types for result code enum conversion.
DEFAULT_SRCADR = 99
Default INM source address.
DEFAULT_TCP_PORT = 2357
Default port number of TCP socket.
DEFAULT_UDP_PORT = 2357
Default port number of UDP socket.
DEFAULT_UDP_PORT = 2999
Default UDP port of internal InetMessageChannel.
DSTADR_SIZE = 1
Size in bytes of the destination address field in an INM message header.
get_timestamp = datetime.datetime.now
Produces a datetime.datetime representing the current local time.
HEADER_SIZE = MESSAGE_ID_SIZE + DSTADR_SIZE + SRCADR_SIZE
Size in bytes of a complete INM message header.
LOCAL_ADR = 0x00
Reserved INM node address for the local node.
make_default_selector = True
If this is true, a default selector object (from the standard library module selectors) will be created for each instance of MessageChannel that isn’t provided with a custom selector at initialization.
MAKE_VAL_ATTR_NAME = 'to_inm_val'
Name of attribute to use for custom conversion of objects into INM message values/payloads.
MAX_DATAGRAM_SIZE = 0xffff
Maximum size of sent UDP datagrams.
MAX_MESSAGE_ADR = 0xff
Largest valid INM node address.
MAX_MESSAGE_ID = 0xffff
Largest valid INM message identifier.
MAX_MESSAGE_LEN = 0xffffffff
Maximum value of the message length field in a large INM message, and thereby also the maximum size in bytes of a large message value field.
MAX_MESSAGE_LEN = 0xff - N_HEADER_BYTES
Maximum supported INM message (value) length.
MAX_MESSAGE_LEN = 0xff
Maximum value of the message length field in a standard INM message, and thereby also the maximum size in bytes of a standard message value field.
MAX_TYPE_NUM = 0xff
Largest valid message type identifier for large INM messages.
MAX_TYPE_NUM = 0x7f
Largest valid message type identifier for standard INM messages.
MESSAGE_ID_SIZE = 2
Size in bytes of the message identifier field in an INM message header.
MESSAGE_LEN_SIZE = 4
Size in bytes of the message length field in a large INM message.
MESSAGE_LEN_SIZE = 1
Size in bytes of the message length field in a standard INM message.
MESSAGE_TYP_SIZE = 1
Size in bytes of the message type identifier field in an INM message.
MIN_MESSAGE_SIZE = Message.MESSAGE_TYP_SIZE + MESSAGE_LEN_SIZE
Minimum size in bytes of a large INM message.
MIN_MESSAGE_SIZE = Message.MESSAGE_TYP_SIZE + MESSAGE_LEN_SIZE
Minimum size in bytes of a standard INM message.
MIN_TYPE_NUM = 0x80
Smallest valid message type identifier for large INM messages.
MIN_TYPE_NUM = 0x00
Smallest valid message type identifier for standard INM messages.
N_HEADER_BYTES = MessageHeader.HEADER_SIZE + StandardMessage.MIN_MESSAGE_SIZE
Total size of the header, type and length fields of an INM message.
PROTOCOL_TYPE_NUM = MAX_TYPE_NUM
Type identifier reserved for INM protocol messages.
RC = inm.ResultCode
Shorthand alias of ResultCode.
Reg = inm.StandardRegisters
Shorthand alias of StandardRegisters.
Res = inm.StandardResults
Shorthand alias of StandardResults.
SRCADR_SIZE = 1
Size in bytes of the source address field in an INM message header.
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.
Typ = inm.StandardTypes
Shorthand alias of StandardTypes.
VC = inm.ValueConversions
Shorthand alias of ValueConversions.
ZERO_DURATION = datetime.timedelta()
A datetime.timedelta representing a zero duration.
Close