FOX-C Messages

Introduction

Any application may use FOX-C-… messages to the FoxApp to request that an outbound FOX request be made to an external OCNCC VWS node by the FoxApp.

Note that n2svcd provides only client support for the FOX protocol, and for this reason there is only a single FoxApp, instead of two separate applications (client and server).

The following LuaApp agents from the core n2svcd module use FoxApp.

The internal FOX-C-… messages are:

Note that this page uses the term “on-the-wire” to refer to the sending or receiving of FOX content by the FoxApp. This term is also inclusive of the case where the message is sent by local loopback and does not physically transit a Network Interface Controller (NIC).

FOX-C-REQUEST

The FOX-C-REQUEST message is sent to FoxApp by any application that wishes to perform an outbound FOX request.

Refer to the FoxApp Configuration documentation for more information on setting default parameters.

The attributes of the FOX-C-REQUEST message are:

Field Type Description
be_id Integer [Required] The numeric ID identifying the BE to which we send the request.
This is the DOMAIN_ID from the CCS_DOMAIN_NODES table in the SMF database.
This will be used to select the appropriate outgoing client connection.
This is also set as the HEAD.SVID in the FOX message.
fox Object Container for the parameters of the FOX request that we are to send.
.TYPE String [Required] The type of the FOX message, e.g. WI.
These message types are specified by Oracle.
.HEAD Object Optional additional FOX header attributes to override the defaults.
Note: You cannot override the DATE, DUP, SVID, USEC, or VER.
.CMID Integer The message “command ID” (a unique message ID).
Use this when you wish to send follow-up requests for an ongoing session.
(Default = FoxApp will automatically generate a new value)
.BODY Object [Required] The nested structure of the FOX message body.
These message bodies are specified by Oracle.

FOX-C-SENT

The FOX-C-SENT message is sent by FoxApp to the requesting application when the original FOX-C-REQUEST is placed on-the-wire.

The attributes of the FOX-C-SENT message are:

Field Type Description
bytes Object [Required] The raw on-the-wire FOX request bytes.
fox Object [Required] The attributes of the FOX message as encoded.
Note however that this object will also contain any field values which were filled-in using default values configured within FoxApp itself.

FOX-C-RESPONSE

The FOX-C-RESPONSE message is sent by FoxApp to the requesting application when a FOX Response is received to the original FOX-C-REQUEST, or if a failure occurs which indicates that no FOX Response will be received.

The attributes of the FOX-C-RESPONSE message are:

Field Type Description
success 0/1 [Required] Indicates if the request was successful or not.
error String Indicates the reason why the request failed.
Present and applicable only if success == 0.
bytes Object The raw on-the-wire FOX response bytes.
Present only if success == 1.
fox Object Container for the FOX response parameters received.
Present only if success == 1.
.TYPE String [Required] The type of the FOX response message, e.g. ACK.
These message types are specified by Oracle.
.HEAD Object [Required] The FOX response header.
This structure is specified by Oracle.
.BODY Object [Required] The FOX response body.
This structure is specified by Oracle.