Editing GeometryServiceNetworkProtocol

Warning: You are not logged in.

Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 12: Line 12:
 
----
 
----
  
 +
==GSNet Msg (Visual) Breakdown==
 +
[[Image:GSNetMsgBreakdown.png|520x373px]]
  
 +
----
  
=GSNet Msg Description=
+
==GSNet Msg==
==Header==
+
===Header===
The header of the GSNet Msg contains the information necessary for quickly determining authenticity, type and length.  Geometry Service's network library, libNetwork, has a header byte layout that looks like this:
+
The header of the GSNet Msg contains the information necessary for quickly determining authenticity, type and length.  Geometry Service's network library, libNetwork, is built upon BRL-CAD's networking library: libPKG.  This causes the header byte layout to look like this:
 
<br /><br />
 
<br /><br />
 
   
 
   
Line 24: Line 27:
 
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 180px;"|'''Value'''
 
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 180px;"|'''Value'''
 
|-
 
|-
|style="border: 1px solid #666699;"|MsgType
+
|style="border: 1px solid #666699;"|Magic1
|style="border: 1px solid #666699;"|int16 (2 bytes)
+
|style="border: 1px solid #666699;"|int16 (2 Bytes)
|style="border: 1px solid #666699;"|
+
|style="border: 1px solid #666699;"|Always 0x41FE
 +
|-
 +
|style="border: 1px solid #666699;"|Magic2
 +
|style="border: 1px solid #666699;"|int16 (2 Bytes)
 +
|style="border: 1px solid #666699;"|Always 0x5309
 
|-
 
|-
 
|style="border: 1px solid #666699;"|MessageLength
 
|style="border: 1px solid #666699;"|MessageLength
 
|style="border: 1px solid #666699;"|int32 (4 bytes)
 
|style="border: 1px solid #666699;"|int32 (4 bytes)
|style="border: 1px solid #666699;"|Does *NOT* include the type or length, so is packet size - 6
+
|style="border: 1px solid #666699;"|
 +
|-
 +
|style="border: 1px solid #666699;"|MsgType
 +
|style="border: 1px solid #666699;"|int16 (2 bytes)
 +
|style="border: 1px solid #666699;"|
 
|-
 
|-
 
|style="border: 1px solid #666699;"|MessageUUID
 
|style="border: 1px solid #666699;"|MessageUUID
Line 46: Line 57:
  
  
* '''MsgType:''' 2 byte integer value that tells what type of message this is.
+
====libPKG Part====
* '''MessageUUID:''' Standard UUID for this message.  Currently stored as a string.
+
Due to some C and C++ incompatibilities, the libPKG "Type" parameter is used as "Magic2" in the GSNet Protocol.  To address this change, NetMsg routing should be performed on the "GS Msg Type" parameter rather than the "libPKG Type" parameter.
* '''HasRegardingUUID:''' Boolean flag that indicates whether there is a Regarding UUID or not.
+
<br /><br />
* '''RegardingMessageUUID:''' Standard UUID that indicates this NetMsg is a response to another NetMsg.
+
Table showing modifications described above:
 +
<br /><br />
 +
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #666699; padding: 0;"
 +
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 180px;"|'''libPKG element'''
 +
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 180px;"|'''GSNet element'''
 +
|-
 +
|style="border: 1px solid #666699;"|Magic
 +
|style="border: 1px solid #666699;"|Magic01
 +
|-
 +
|style="border: 1px solid #666699;"|Type
 +
|style="border: 1px solid #666699;"|Magic02
 +
|-
 +
|style="border: 1px solid #666699;"|Length
 +
|style="border: 1px solid #666699;"|Length
 +
|}
 +
 
 +
* '''Magic01:''' 2 bytes of data designed to ensure integrity of data and mark NetMsg starting point.
 +
* '''Magic02:''' 2 bytes of data designed to ensure integrity of data and mark NetMsg starting point.
 +
* '''Length:''' 4 byte integer that represents the number of bytes in the message from the end of this value to the end.
 +
 
 +
====GSNet Part====
 +
 
  
 
----
 
----
  
==Data==
+
===Data===
 
----
 
----
The Data load of a NetMsg is, obivously, the important and unique part.  Data Loads can be as small as zero (in the case of a TypeOnlyMsg) or many kilobytes long.
 
  
Here is a list of [[NetMsgTypes|NetMsg types]] and here is a list of [[Common NetMsg Exchanges]].
+
 
 +
List of [[NetMsgTypes]].
 +
 +
List of [[Common NetMsg Exchanges]]

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)