Difference between revisions of "NetMsgTypes"

From BRL-CAD
(NetMsg MsgTypes)
Line 48: Line 48:
 
!width="200" align="center"|  
 
!width="200" align="center"|  
 
|-
 
|-
| [[GenericOneByteMsg]]  
+
| [[GenericOneByteMsg|Generic One Byte msg]]  
| [[GenericTwoBytesMsg]]  
+
| [[GenericTwoBytesMsg|Generic Two Byte msg]]  
| [[GenericFourBytesMsg]]  
+
| [[GenericFourBytesMsg|Generic Four Byte msg]]  
 
|-
 
|-
| [[GenericMultiByteMsg]]  
+
| [[GenericMultiByteMsg|Generic Multi Byte msg]]  
| [[GenericOneStringMsg]]  
+
| [[GenericOneStringMsg|Generic One String msg]]  
 
|  
 
|  
 
|}
 
|}
 
 
==NetMsg MsgTypes==
 
==NetMsg MsgTypes==
 
Some [[IBME_GeometryService#NetMsg_Class|NetMsgs]] will need to have custom bodies.  Here is a list of [[IBME_GeometryService#NetMsg_Class|NetMsgs]], their related MsgTypes, and links to details on that specific [[IBME_GeometryService#NetMsg_Class|NetMsg]]:
 
Some [[IBME_GeometryService#NetMsg_Class|NetMsgs]] will need to have custom bodies.  Here is a list of [[IBME_GeometryService#NetMsg_Class|NetMsgs]], their related MsgTypes, and links to details on that specific [[IBME_GeometryService#NetMsg_Class|NetMsg]]:
Line 62: Line 61:
 
   
 
   
 
{|
 
{|
!width="55"|MsgTypeID
+
!width="60"|MsgTypeID
!Name
+
!width="60"|Name
 
!Description
 
!Description
 
|-
 
|-
|width="55"|0
+
|width="60"|0
|[[Failure]]
+
|width="60"|[[Failure]]
|Uses GenericOneByteMsg
+
|Uses [[GenericOneByteMsg|Generic One Byte msg]]
 
|-
 
|-
|width="55"|5
+
|width="60"|5
|[[Success]]
+
|width="60"|[[Success]]
 +
|
 
|-
 
|-
|width="55"|100
+
|width="60"|100
|[[RemHostNameSET]]
+
|width="60"|[[RemHostNameSET]]
 +
|
 
|-
 
|-
|width="55"|150
+
|width="60"|150
|[[DisconnectREQ]]
+
|width="60"|[[DisconnectREQ]]
 +
|
 
|-
 
|-
|width="55"|200
+
|width="60"|200
|[[NewHostOnNet]]
+
|width="60"|[[NewHostOnNet]]
 +
|
 
|-
 
|-
|width="55"|250
+
|width="60"|250
|[[FullHostListREQ]]*
+
|width="60"|[[FullHostListREQ]]*
 +
|
 
|-
 
|-
|width="55"|255
+
|width="60"|260
|[[FullHostList]]*
+
|width="60"|[[FullHostList]]*
 +
|
 
|-
 
|-
|width="55"|300
+
|width="60"|300
|[[NewSessionREQ]]*
+
|width="60"|[[NewSessionREQ]]*
 +
|
 
|-
 
|-
|width="55"|305
+
|width="60"|305
|[[NewSession]]*
+
|width="60"|[[NewSession]]*
 +
|
 
|-
 
|-
|width="55"|400
+
|width="60"|400
|[[GeometryREQ]]
+
|width="60"|[[GeometryREQ]]
 +
|
 
|-
 
|-
|width="55"|405
+
|width="60"|405
|[[GeometryMANIFEST]]
+
|width="60"|[[GeometryMANIFEST]]
 +
|
 
|-
 
|-
|width="55"|410
+
|width="60"|410
|[[GeometryCHUNK]]
+
|width="60"|[[GeometryCHUNK]]
 +
|
 
|}
 
|}

Revision as of 08:21, 21 September 2010

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 Notes
Magic1 int16 (2 Bytes) Always 0x41FE
Magic2 int16 (2 Bytes) Always 0x5309
MessageLength int32 (4 bytes)
MsgType int16 (2 bytes)
MessageUUID String (Variable bytes)
HasRegardingUUID Boolean (1 byte)
RegardingMessageUUID String (Variable bytes)

NetMsg Generic Templates

The GSNet Protocol provides several Template classes to be used or extended from.

     
Generic One Byte msg Generic Two Byte msg Generic Four Byte msg
Generic Multi Byte msg Generic One String msg

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 Name Description
0 Failure Uses Generic One Byte msg
5 Success
100 RemHostNameSET
150 DisconnectREQ
200 NewHostOnNet
250 FullHostListREQ*
260 FullHostList*
300 NewSessionREQ*
305 NewSession*
400 GeometryREQ
405 GeometryMANIFEST
410 GeometryCHUNK