Shadow Network Framework  0.0.1-alpha
.NET Client Library for Shadow Network Framework
Loading...
Searching...
No Matches
SNFClient.Request Class Reference

"Request" Members are the object that are sent through SNF.Client.Connection More...

Classes

class  Handler
 This Class where each instance Handles the created Requests and sends them through the Connection it was Initialized with. More...
 

Public Member Functions

 Request (byte[] UID, OPCode OPCODE, byte[][] Args, RequestResponseCB OnResponse)
 Constructor for a new Request Instance.
 
 Request (byte[] UID, OPCode OPCODE, byte[][] Args)
 Constructor for a new Request Instance without a CallBack.
 
 Request (OPCode OPCODE, byte[][] Args, RequestResponseCB OnResponse)
 Constructor for a new Request Instance with a UID Generated with generateUID
 
 Request (OPCode OPCODE, byte[][] Args)
 Constructor for a new Request Instance with a UID Generated with generateUID and without a Callback.
 
 Request (OPCode OPCODE, RequestResponseCB OnResponse)
 Constructor for a new Request Instance with a UID Generated with generateUID and without any Arguments.
 
 Request (OPCode OPCODE)
 Constructor for a new Request Instance with a UID Generated with generateUID and without any Arguments or a Callback.
 
byte[] FirstArg ()
 Gets the First Argument of a Request.
 
byte[] LastArg ()
 Gets the Last Argument of a Request.
 
byte[] Arg (int Index)
 Get the indexed Argument.
 

Static Public Member Functions

static byte[] generateUID ()
 Generates a new UID for Each Request.
 

Properties

static int _UID_LENGTH [get]
 The length of the UID of each Request "Request".
 
byte[] UID [get]
 Used to get the UID of the Request.
 
OPCode OPCode [get]
 Used to get the OPCode of the the Request.
 
byte[][] Args [get]
 Used to get the Arguments that would be sent with the Request.
 
bool Awaitsresponse [get]
 Used to get if the request await a response.
 

Detailed Description

"Request" Members are the object that are sent through SNF.Client.Connection

Constructor & Destructor Documentation

◆ Request() [1/6]

SNFClient.Request.Request ( byte[] UID,
OPCode OPCODE,
byte Args[][],
RequestResponseCB OnResponse )
inline

Constructor for a new Request Instance.

Parameters
UIDUnique IDentifier for the Request
OPCODEOPCode of the Request
ArgsArguments to be Sent
OnResponseResponse CallBack

◆ Request() [2/6]

SNFClient.Request.Request ( byte[] UID,
OPCode OPCODE,
byte Args[][] )
inline

Constructor for a new Request Instance without a CallBack.

Parameters
UIDUnique IDentifier for the Request
OPCODEOPCode of the Request
ArgsArguments to be Sent

◆ Request() [3/6]

SNFClient.Request.Request ( OPCode OPCODE,
byte Args[][],
RequestResponseCB OnResponse )
inline

Constructor for a new Request Instance with a UID Generated with generateUID

Parameters
OPCODEOPCode of the Request
ArgsArguments to be Sent
OnResponseResponse CallBack

◆ Request() [4/6]

SNFClient.Request.Request ( OPCode OPCODE,
byte Args[][] )
inline

Constructor for a new Request Instance with a UID Generated with generateUID and without a Callback.

Parameters
OPCODEOPCode of the Request
ArgsArguments to be Sent

◆ Request() [5/6]

SNFClient.Request.Request ( OPCode OPCODE,
RequestResponseCB OnResponse )
inline

Constructor for a new Request Instance with a UID Generated with generateUID and without any Arguments.

Parameters
OPCODEOPCode of the Request
OnResponseResponse CallBack

◆ Request() [6/6]

SNFClient.Request.Request ( OPCode OPCODE)
inline

Constructor for a new Request Instance with a UID Generated with generateUID and without any Arguments or a Callback.

Parameters
OPCODEOPCode of the Request

Member Function Documentation

◆ generateUID()

static byte[] SNFClient.Request.generateUID ( )
inlinestatic

Generates a new UID for Each Request.

Returns

◆ FirstArg()

byte[] SNFClient.Request.FirstArg ( )

Gets the First Argument of a Request.

Returns
First Argument | null if instance has no Arguments

◆ LastArg()

byte[] SNFClient.Request.LastArg ( )

Gets the Last Argument of a Request.

Returns
last Argument | null if instance has no Arguments

◆ Arg()

byte[] SNFClient.Request.Arg ( int Index)

Get the indexed Argument.

Parameters
IndexIndex of the aregument
Returns
Indexed Argument

Property Documentation

◆ _UID_LENGTH

int SNFClient.Request._UID_LENGTH
staticget

The length of the UID of each Request "Request".

◆ UID

byte [] SNFClient.Request.UID
get

Used to get the UID of the Request.

Note
You can generate a UID using generateUID

◆ OPCode

OPCode SNFClient.Request.OPCode
get

Used to get the OPCode of the the Request.

See also
OPCode

◆ Args

byte [][] SNFClient.Request.Args
get

Used to get the Arguments that would be sent with the Request.

◆ Awaitsresponse

bool SNFClient.Request.Awaitsresponse
get

Used to get if the request await a response.


The documentation for this class was generated from the following file: