netmsgs  1.2.2
RoadNarrows Robotics Network Messaging Package
Public Member Functions | List of all members
NetMsgs.NetMsgsLibFlat.NetMsgsFlat Class Reference
Inheritance diagram for NetMsgs.NetMsgsLibFlat.NetMsgsFlat:

Public Member Functions

def __init__ (self, msgdefset, kwargs)
 
def nmPackFieldHdr (self, fielddef, val, stateId)
 
def nmPackMsgHdr (self, msgid, msgdef, stateId)
 
def nmUnpackFieldHdr (self, buf, offset, stateId)
 
def nmUnpackMsgHdr (self, msgid, msgdef, buf, offset, fvals, stateId)
 

Detailed Description

RoadNarrows Flat Fixed-Field encode Net Messages Class.

    Flat message encoding for fixed-sized, flat messages with no message or
    field header information.

Definition at line 78 of file NetMsgsLibFlat.py.

Constructor & Destructor Documentation

def NetMsgs.NetMsgsLibFlat.NetMsgsFlat.__init__ (   self,
  msgdefset,
  kwargs 
) 
Initialize NetMsgsFlat instance.

Parameters:
  msgdefset - Set of message definitions.
  kwargs    - Optional keyword arguments. See NetMsgsStreamBuf.

Definition at line 86 of file NetMsgsLibFlat.py.

86  def __init__(self, msgdefset, **kwargs):
87  """ Initialize NetMsgsFlat instance.
88 
89  Parameters:
90  msgdefset - Set of message definitions.
91  kwargs - Optional keyword arguments. See NetMsgsStreamBuf.
92  """
93  kwargs['encoding'] = 'flat'
94  nmStream.NetMsgsStreamBuf.__init__(self, msgdefset, **kwargs)
NetMsgs.NetMsgsLibFlat.NetMsgsFlat.__init__
def __init__(self, msgdefset, kwargs)
Definition: NetMsgsLibFlat.py:86

Member Function Documentation

def NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmPackFieldHdr (   self,
  fielddef,
  val,
  stateId 
) 
Pack field header. 

No header is packed.

Parameters:
  fielddef  - Field definition.
  val       - Field value(s).
  stateId   - Packing state id.

Return:
  Packed buffer.

Definition at line 103 of file NetMsgsLibFlat.py.

References NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.StateFieldSet().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackBool(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackChar(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackF32(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackF64(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackP32(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackP64(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS16(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS32(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS64(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackS8(), NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackString(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackString(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackStruct(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU16(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU32(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU64(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackU8(), NetMsgs.NetMsgsLibITV.NetMsgsITV.nmPackVector(), and NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackVector().

103  def nmPackFieldHdr(self, fielddef, val, stateId):
104  """ Pack field header.
105 
106  No header is packed.
107 
108  Parameters:
109  fielddef - Field definition.
110  val - Field value(s).
111  stateId - Packing state id.
112 
113  Return:
114  Packed buffer.
115  """
116  self.StateFieldSet(stateId, fhdr={'fhdr_size': 0})
117  return ''
NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmPackFieldHdr
def nmPackFieldHdr(self, fielddef, val, stateId)
Definition: NetMsgsLibFlat.py:103
def NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmPackMsgHdr (   self,
  msgid,
  msgdef,
  stateId 
) 
Pack message header. 

No header is packed.

Parameters:
  msgid     - Message identifier.
  msgdef    - Message definition.
  stateId   - Packing state id.

Return:
  Packed buffer.

Definition at line 121 of file NetMsgsLibFlat.py.

References NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.StateSet().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmPackMsg().

121  def nmPackMsgHdr(self, msgid, msgdef, stateId):
122  """ Pack message header.
123 
124  No header is packed.
125 
126  Parameters:
127  msgid - Message identifier.
128  msgdef - Message definition.
129  stateId - Packing state id.
130 
131  Return:
132  Packed buffer.
133  """
134  self.StateSet(stateId, msghdr={'msghdr_size': 0})
135  return ''
NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmPackMsgHdr
def nmPackMsgHdr(self, msgid, msgdef, stateId)
Definition: NetMsgsLibFlat.py:121
def NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmUnpackFieldHdr (   self,
  buf,
  offset,
  stateId 
) 
Unpack field header. 

No header is unpacked.

Parameters:
  buf       - Buffer to unpack.
  offset    - Buffer offset where unpacking begins.
  stateId   - Unpacking state id.

Return:
  New buffer offset.

Definition at line 143 of file NetMsgsLibFlat.py.

References NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.StateFieldSet().

Referenced by NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackStream(), NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackStream(), and NetMsgs.NetMsgsLibITV.NetMsgsITV.nmUnpackVector().

143  def nmUnpackFieldHdr(self, buf, offset, stateId):
144  """ Unpack field header.
145 
146  No header is unpacked.
147 
148  Parameters:
149  buf - Buffer to unpack.
150  offset - Buffer offset where unpacking begins.
151  stateId - Unpacking state id.
152 
153  Return:
154  New buffer offset.
155  """
156  fhdr = self.StateFieldSet(stateId, fhdr={'fhdr_size': 0})
157  return offset
NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmUnpackFieldHdr
def nmUnpackFieldHdr(self, buf, offset, stateId)
Definition: NetMsgsLibFlat.py:143
def NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmUnpackMsgHdr (   self,
  msgid,
  msgdef,
  buf,
  offset,
  fvals,
  stateId 
) 
Unpack message header. 

No header is unpacked.

Parameters:
  msgid     - Message identifier.
  msgdef    - Message definition.
  buf       - Buffer to unpack.
  offset    - Buffer offset where unpacking begins.
  fvals     - Dictionary to hold unpacked field values.
  stateId   - Unpacking state id.

Return:
  New buffer offset.

Definition at line 161 of file NetMsgsLibFlat.py.

References NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.StateSet().

Referenced by NetMsgs.NetMsgsLibStreamBuf.NetMsgsStreamBuf.nmUnpackMsg().

161  def nmUnpackMsgHdr(self, msgid, msgdef, buf, offset, fvals, stateId):
162  """ Unpack message header.
163 
164  No header is unpacked.
165 
166  Parameters:
167  msgid - Message identifier.
168  msgdef - Message definition.
169  buf - Buffer to unpack.
170  offset - Buffer offset where unpacking begins.
171  fvals - Dictionary to hold unpacked field values.
172  stateId - Unpacking state id.
173 
174  Return:
175  New buffer offset.
176  """
177  self.StateSet(stateId, msghdr={'msghdr_size': 0})
178  return offset
NetMsgs.NetMsgsLibFlat.NetMsgsFlat.nmUnpackMsgHdr
def nmUnpackMsgHdr(self, msgid, msgdef, buf, offset, fvals, stateId)
Definition: NetMsgsLibFlat.py:161
The documentation for this class was generated from the following file: