Shadow Network Framework  0.0.2-alpha
.NET Client Library for Shadow Network Framework
Loading...
Searching...
No Matches
Static Public Member Functions | Properties | List of all members
SNFClient.OPCode.Base Class Reference

This Class Defined THe Base OPCode Structure for Basic SNF Functioning. More...

Static Public Member Functions

static void Initialize ()
 Initializes OPCode.Base.
 
static Member getCategory ()
 Returns the Base Category.
 
static Member getSubcategory ()
 Returns the base Subcategory.
 
static Member getCommand (byte Command)
 Returns the base Command.
 
static Member getDetail (byte Command, byte Detail)
 Returns the base Command with a certain Detail.
 
static OPCode get (byte Command)
 Gets an OPCode using a Base Command without any detail.
 
static OPCode get (byte Command, byte Detail)
 Gets an OPCode using a Base Command with a detail.
 
static OPCode getInvalid ()
 Gets an OPCode using a 'Invalid' Command without any detail.
 
static OPCode getInvalid (byte Detail)
 Gets an OPCode using a 'Invalid' Command with a detail.
 

Properties

static byte CATEGORY [get]
 Base Category for SNF.
 
static byte SUBCATEGORY [get]
 Base Sub-Category for SNF.
 
static byte DET_UNDETAILED [get]
 Default Detail for every Command.
 
static byte CMD_CONNECT [get]
 When client attemps to connect.
 
static byte CMD_RECONNECT [get]
 When client attemps to reconnect - or forced to.
 
static byte CMD_DISCONNECT [get]
 When client attemps to disconnect.
 
static byte CMD_SNF_VER [get]
 When client requests SNF version of the Server.
 
static byte CMD_KICK [get]
 When client was forced to disconnect ( Kicked ).
 
static byte CMD_CONFIRM [get]
 When client's reuqest was confirmed.
 
static byte CMD_REJECT [get]
 When client's request was rejected.
 
static byte CMD_INVALID [get]
 When client's request was invalid either, wrong version or incomplete request.
 
static byte DET_INVALID_UNREGISTRED_OPCODE [get]
 Received opcode on the server side was not registred.
 
static byte DET_INVALID_ERROR_PROTOCOL [get]
 Protocol used is invalid.
 
static byte DET_INVALID_UNIMPLEMENTED_OPCODE [get]
 Sent OPCode does not have a function to call on the server side.
 
static bool isInitialized [get]
 Returns if OPCode.Base is initialized or not.
 

Detailed Description

This Class Defined THe Base OPCode Structure for Basic SNF Functioning.

Member Function Documentation

◆ Initialize()

static void SNFClient.OPCode.Base.Initialize ( )
static

Initializes OPCode.Base.

◆ getCategory()

static Member SNFClient.OPCode.Base.getCategory ( )
static

Returns the Base Category.

Returns
null if Class is uninitialized

◆ getSubcategory()

static Member SNFClient.OPCode.Base.getSubcategory ( )
static

Returns the base Subcategory.

Returns

◆ getCommand()

static Member SNFClient.OPCode.Base.getCommand ( byte Command)
static

Returns the base Command.

Parameters
Commandbase command to search for
Returns
null if Class is uninitialized or not found

◆ getDetail()

static Member SNFClient.OPCode.Base.getDetail ( byte Command,
byte Detail )
static

Returns the base Command with a certain Detail.

Parameters
CommandBase Command
DetailBase Command's Detail
Returns
null if Class is uninitialized or command not found and the Undetailed 'Detail' if Detail wasnot found

◆ get() [1/2]

static OPCode SNFClient.OPCode.Base.get ( byte Command)
static

Gets an OPCode using a Base Command without any detail.

To Specify a Detail :

See also
get(byte, byte)
Parameters
CommandBase Command
Returns
OPCode Instance if Command is a valid Base Command else null
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized
Exceptions.OPCode.UnregistredCommand Is not a registred OPCode Command

◆ get() [2/2]

static OPCode SNFClient.OPCode.Base.get ( byte Command,
byte Detail )
static

Gets an OPCode using a Base Command with a detail.

Parameters
CommandBase Command
DetailBase Command's Detail
Returns
OPCode Instance if Command is a valid Base Command else null
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized
Exceptions.OPCode.UnregistredCommand Is not a registred OPCode Command

◆ getInvalid() [1/2]

static OPCode SNFClient.OPCode.Base.getInvalid ( )
static

Gets an OPCode using a 'Invalid' Command without any detail.

To Specify a Detail :

See also
getInvalid(byte)
Returns
OPCode Instance if Command is a valid Base Command else null
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized

◆ getInvalid() [2/2]

static OPCode SNFClient.OPCode.Base.getInvalid ( byte Detail)
static

Gets an OPCode using a 'Invalid' Command with a detail.

Returns
OPCode Instance if Command is a valid Base Command else null
Exceptions
Exceptions.ClassUninitializedThrown When The OPCode.Base Class was not Initialized

Property Documentation

◆ CATEGORY

byte SNFClient.OPCode.Base.CATEGORY
staticget

Base Category for SNF.

◆ SUBCATEGORY

byte SNFClient.OPCode.Base.SUBCATEGORY
staticget

Base Sub-Category for SNF.

◆ DET_UNDETAILED

byte SNFClient.OPCode.Base.DET_UNDETAILED
staticget

Default Detail for every Command.

◆ CMD_CONNECT

byte SNFClient.OPCode.Base.CMD_CONNECT
staticget

When client attemps to connect.

◆ CMD_RECONNECT

byte SNFClient.OPCode.Base.CMD_RECONNECT
staticget

When client attemps to reconnect - or forced to.

◆ CMD_DISCONNECT

byte SNFClient.OPCode.Base.CMD_DISCONNECT
staticget

When client attemps to disconnect.

◆ CMD_SNF_VER

byte SNFClient.OPCode.Base.CMD_SNF_VER
staticget

When client requests SNF version of the Server.

◆ CMD_KICK

byte SNFClient.OPCode.Base.CMD_KICK
staticget

When client was forced to disconnect ( Kicked ).

◆ CMD_CONFIRM

byte SNFClient.OPCode.Base.CMD_CONFIRM
staticget

When client's reuqest was confirmed.

◆ CMD_REJECT

byte SNFClient.OPCode.Base.CMD_REJECT
staticget

When client's request was rejected.

◆ CMD_INVALID

byte SNFClient.OPCode.Base.CMD_INVALID
staticget

When client's request was invalid either, wrong version or incomplete request.

◆ DET_INVALID_UNREGISTRED_OPCODE

byte SNFClient.OPCode.Base.DET_INVALID_UNREGISTRED_OPCODE
staticget

Received opcode on the server side was not registred.

◆ DET_INVALID_ERROR_PROTOCOL

byte SNFClient.OPCode.Base.DET_INVALID_ERROR_PROTOCOL
staticget

Protocol used is invalid.

◆ DET_INVALID_UNIMPLEMENTED_OPCODE

byte SNFClient.OPCode.Base.DET_INVALID_UNIMPLEMENTED_OPCODE
staticget

Sent OPCode does not have a function to call on the server side.

◆ isInitialized

bool SNFClient.OPCode.Base.isInitialized
staticget

Returns if OPCode.Base is initialized or not.

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