Difference between revisions of "Failure"

From BRL-CAD
(New page: {{DesignDocument}} ==Description== NetMsg that is a response to a previously sent NetMsg subclass to inform the...)
 
(Added references to Generics.)
Line 2: Line 2:
  
 
==Description==
 
==Description==
[[IBME_GeometryService#NetMsg_Class|NetMsg]] that is a response to a previously sent [[IBME_GeometryService#NetMsg_Class|NetMsg]] subclass to inform the sender that the action has failed.  The FailureMsg references the failed action by way of the RegardingUUID field.
+
[[IBME_GeometryService#NetMsg_Class|NetMsg]] that is a response to a previously sent [[IBME_GeometryService#NetMsg_Class|NetMsg]] subclass to inform the sender that the action has failed.  The FailureMsg references the failed action by way of the RegardingUUID field.  Extends [[GenericOneByteMsg]] (thus contains those fields also).  The single byte field from [[GenericOneByteMsg]] is the Failure Code.
  
 
==Byte Format==
 
==Byte Format==
 
   
 
   
   
+
No additional fields beyond that of the [[NetMsgTypes|Common Header]] and [[GenericOneByteMsg]]
{|border="1"
+
 
|width="75"|'''Element'''
 
|'''Length'''
 
|-
 
|FailureCode
 
|byte (1 byte)
 
|}
 
 
 
   
 
   
 
==Failure Codes==
 
==Failure Codes==
 
'''''TBD'''''
 
'''''TBD'''''

Revision as of 14:55, 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.


Description

NetMsg that is a response to a previously sent NetMsg subclass to inform the sender that the action has failed. The FailureMsg references the failed action by way of the RegardingUUID field. Extends GenericOneByteMsg (thus contains those fields also). The single byte field from GenericOneByteMsg is the Failure Code.

Byte Format

No additional fields beyond that of the Common Header and GenericOneByteMsg


Failure Codes

TBD