Difference between revisions of "NetMsgTypes"

From BRL-CAD
(Added Generic*Msg Template linkage)
(Added links to IBME_NETWORKPROTO_STRING)
Line 4: Line 4:
 
==Common Header Byte Format==
 
==Common Header Byte Format==
 
All [[IBME_GeometryService#NetMsg_Class|NetMsgs]] will contain a uniform header:
 
All [[IBME_GeometryService#NetMsg_Class|NetMsgs]] will contain a uniform header:
 +
 
   
 
   
 
{|border="1"
 
{|border="1"
|width="75"|'''Element'''
+
|width="180"|'''Element'''
|'''Length'''
+
|width="180"|'''Length'''
 
|-
 
|-
 
|MessageLength
 
|MessageLength
Line 16: Line 17:
 
|-
 
|-
 
|MessageUUID
 
|MessageUUID
|String (Variable bytes)
+
|[[IBME_NETWORKPROTO_STRING|String (Variable bytes)]]
 
|-
 
|-
 
|HasRegardingUUID
 
|HasRegardingUUID
Line 22: Line 23:
 
|-
 
|-
 
|RegardingMessageUUID
 
|RegardingMessageUUID
|String (Variable bytes)
+
|[[IBME_NETWORKPROTO_STRING|String (Variable bytes)]]
 
|}
 
|}
  

Revision as of 14:04, 25 November 2009

Design icon.png This page contains the design document for an enhancement or feature. The design should be considered a work in progress and may not represent the final design. As this is a collaborative design, contributions and participation from other developers and users is encouraged. Use the discussion page for providing comments and suggestions.


Common Header Byte Format

All NetMsgs will contain a uniform header:


Element Length
MessageLength int32 (4 bytes)
MsgType int32 (4 bytes)
MessageUUID String (Variable bytes)
HasRegardingUUID Boolean (1 byte)
RegardingMessageUUID String (Variable bytes)

NetMsg Generic Templates

     
GenericOneByteMsg GenericTwoBytesMsg GenericFourBytesMsg
GenericMultiByteMsg GenericOneStringMsg

NetMsg MsgTypes

Some NetMsgs will need to have custom bodies. Here is a list of NetMsgs, their related MsgTypes, and links to details on that specific NetMsg:


MsgTypeID Description
0 Failure
5 Success
100 RemHostNameSET
150 DisconnectREQ
200 NewHostOnNetINFO
250 FullHostListREQ
255 FullHostList
300 NewSessionREQ
305 NewSession
400 GeometryREQ
405 GeometryMANIFEST
410 GeometryCHUNK