Editing NetMsgTypes

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 1: Line 1:
----
+
==NetMsg Generic Templates==
=NetMsg Generic Templates=
+
The GSNet Protocol provides several Template classes to be used or extended from.
----
+
The GSNet API provides several Template classes to be used or extended from.
+
  
 
* [[GenericOneByteMsg|Generic One Byte Msg]]  
 
* [[GenericOneByteMsg|Generic One Byte Msg]]  
 
* [[GenericTwoBytesMsg|Generic Two Byte Msg]]  
 
* [[GenericTwoBytesMsg|Generic Two Byte Msg]]  
 
* [[GenericFourBytesMsg|Generic Four Byte Msg]]  
 
* [[GenericFourBytesMsg|Generic Four Byte Msg]]  
* [[GenericEightByteMsg|Generic Eight Byte Msg]]
 
 
* [[GenericMultiByteMsg|Generic Multi Byte Msg]]  
 
* [[GenericMultiByteMsg|Generic Multi Byte Msg]]  
 
* [[GenericOneStringMsg|Generic One String Msg]]
 
* [[GenericOneStringMsg|Generic One String Msg]]
* [[GenericMultiStringMsg|Generic Multi-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:
  
=NetMsg MsgTypes=
+
'''NOTE:'''  This list is not uptodate as of 1.25.11
----
+
 
+
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:
+
<br /><br />
+
'''NOTE:'''  This list is *NOT* up-to-date as of 3.25.11
+
<br /><br />
+
'''TODO:'''  Replace this with Doxy files
+
<br /><br />
+
  
 +
 
{|style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: #666699; padding: 0;"
 
{|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: 90px;"|'''MsgType ID'''
 
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 90px;"|'''MsgType ID'''
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 200px;"|'''Name'''
+
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 90px;"|'''Name'''
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF; width: 180px;"|'''Parent Class'''
+
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF;"|'''Description'''
|style="border: 1px solid #666699; background-color: #666699; color: #FFFFFF;"|'''Additional Info'''
+
|-
+
|style="border: 1px solid #666699;"|0x0042
+
|style="border: 1px solid #666699;"|RUALIVE
+
|style="border: 1px solid #666699;"|[[TypeOnlyMsg]]
+
|style="border: 1px solid #666699;"|Ping without time info (necessary?)
+
|-
+
|style="border: 1px solid #666699;"|0x0043
+
|style="border: 1px solid #666699;"|IMALIVE
+
|style="border: 1px solid #666699;"|[[TypeOnlyMsg]]
+
|style="border: 1px solid #666699;"|Pong without time info (necessary?)
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0050
 
|style="border: 1px solid #666699;"|0x0050
|style="border: 1px solid #666699;"|Failure
+
|style="border: 1px solid #666699;"|[[Failure]]
|style="border: 1px solid #666699;"|[[GenericOneByteMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericOneByteMsg|Generic One Byte Msg]].
|style="border: 1px solid #666699;"|1 byte 'error code'
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0051
 
|style="border: 1px solid #666699;"|0x0051
|style="border: 1px solid #666699;"|Success
+
|style="border: 1px solid #666699;"|[[Success]]
|style="border: 1px solid #666699;"|[[GenericOneByteMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericOneByteMsg|Generic One Byte Msg]].
|style="border: 1px solid #666699;"|1 byte 'success code'
+
|-
+
|style="border: 1px solid #666699;"|0x0060
+
|style="border: 1px solid #666699;"|PING
+
|style="border: 1px solid #666699;"|[[GenericEightByteMsg]]
+
|style="border: 1px solid #666699;"|8 byte time stamp for start time
+
|-
+
|style="border: 1px solid #666699;"|0x0062
+
|style="border: 1px solid #666699;"|PONG
+
|style="border: 1px solid #666699;"|[[GenericEightByteMsg]]
+
|style="border: 1px solid #666699;"|8 byte time stamp for start time, dup of the ping value
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0100
 
|style="border: 1px solid #666699;"|0x0100
|style="border: 1px solid #666699;"|GS Remote Nodename Set
+
|style="border: 1px solid #666699;"|[[RemHostNameSET]]
|style="border: 1px solid #666699;"|[[GenericOneStringMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericOneStringMsg|Generic One String Msg]].
|style="border: 1px solid #666699;"|String is the Nodename
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0150
 
|style="border: 1px solid #666699;"|0x0150
|style="border: 1px solid #666699;"|Disconnect Request
+
|style="border: 1px solid #666699;"|[[DisconnectREQ]]
|style="border: 1px solid #666699;"|[[TypeOnlyMsg]]
+
|style="border: 1px solid #666699;"|"MsgType Only" NetMsg and has no body.
|style="border: 1px solid #666699;"|
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0200
 
|style="border: 1px solid #666699;"|0x0200
|style="border: 1px solid #666699;"|New Node on Network
+
|style="border: 1px solid #666699;"|[[NewHostOnNet]]
|style="border: 1px solid #666699;"|[[GenericOneStringMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericOneStringMsg|Generic One String Msg]].
|style="border: 1px solid #666699;"|String is the Nodename
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0250
 
|style="border: 1px solid #666699;"|0x0250
|style="border: 1px solid #666699;"|Full Nodename List Request
+
|style="border: 1px solid #666699;"|[[FullHostListREQ]]*
|style="border: 1px solid #666699;"|
+
 
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
 
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0255
 
|style="border: 1px solid #666699;"|0x0255
|style="border: 1px solid #666699;"|Full Nodename List
+
|style="border: 1px solid #666699;"|[[FullHostList]]*
|style="border: 1px solid #666699;"|
+
 
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
 
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0300
 
|style="border: 1px solid #666699;"|0x0300
|style="border: 1px solid #666699;"|[[NewSessionReqMsg|New Session Request]]
+
|style="border: 1px solid #666699;"|[[NewSessionREQ]]*
|style="border: 1px solid #666699;"|[[NetMsg]]
+
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
|style="border: 1px solid #666699;"|Two strings, username and password
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0305
 
|style="border: 1px solid #666699;"|0x0305
|style="border: 1px solid #666699;"|[[SessionInfoMsg|Session Information]]
+
|style="border: 1px solid #666699;"|[[NewSession]]*
|style="border: 1px solid #666699;"|[[NetMsg]]
+
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
|style="border: 1px solid #666699;"|One string, the session UUID
+
|-
 +
|style="border: 1px solid #666699;"|0x0310
 +
|style="border: 1px solid #666699;"|[[LogoutSession]]
 +
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0400
 
|style="border: 1px solid #666699;"|0x0400
|style="border: 1px solid #666699;"|[[GeometryReqMsg|Geometry Request]]
+
|style="border: 1px solid #666699;"|[[GeometryREQ]]
|style="border: 1px solid #666699;"|[[GenericOneStringMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericOneStringMsg|Generic One String Msg]] in addition to custom fields.
|style="border: 1px solid #666699;"|Has additional custom fields.
+
|-
+
|style="border: 1px solid #666699;"|0x0401
+
|style="border: 1px solid #666699;"|[[GeometryBoTReqMsg|BoT Geometry Request]]
+
|style="border: 1px solid #666699;"|[[GenericOneStringMsg]]
+
|style="border: 1px solid #666699;"|Requests geometry in BoT format, with exactly one BoT per region.
+
|-
+
|style="border: 1px solid #666699;"|0x0402
+
|style="border: 1px solid #666699;"|[[GeometryListReqMsg|Geometry List Request]]
+
|style="border: 1px solid #666699;"|[[GenericOneStringMsg]]
+
|style="border: 1px solid #666699;"|Requests a list of geometry artifacts at given location.
+
|-
+
|style="border: 1px solid #666699;"|0x0403
+
|style="border: 1px solid #666699;"|[[GeometryListResMsg|Geometry List Results]]
+
|style="border: 1px solid #666699;"|[[GenericMultiStringMsg]]
+
|style="border: 1px solid #666699;"|Display a list of geometry artifact names.
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0405
 
|style="border: 1px solid #666699;"|0x0405
|style="border: 1px solid #666699;"|[[GeometryManifestMsg|Geometry Manifest]]
+
|style="border: 1px solid #666699;"|[[GeometryMANIFEST]]
|style="border: 1px solid #666699;"|[[GenericMultiStringMsg]]
+
|style="border: 1px solid #666699;"|'''''Not Implemented Yet'''
|style="border: 1px solid #666699;"|List of 'object' names about to be received as chunks. ReUUID is the associated GeometryReqMsg UUID.
+
 
|-
 
|-
 
|style="border: 1px solid #666699;"|0x0410
 
|style="border: 1px solid #666699;"|0x0410
|style="border: 1px solid #666699;"|[[GeometryChunkMsg|Geometry Chunk]]
+
|style="border: 1px solid #666699;"|[[GeometryCHUNK]]
|style="border: 1px solid #666699;"|[[GenericMultiByteMsg]]
+
|style="border: 1px solid #666699;"|Uses [[GenericMultiByteMsg|Generic Multi Byte Msg]].
|style="border: 1px solid #666699;"|Raw .g information. Chunks can be written to a file to produce a viable V5 .g db. ReUUID is the associated GeometryReqMsg UUID.
+
 
|}
 
|}

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)