SuperTcpServerChannelWorker

Overview

Location

Implements

 

constructor

 

constructor(owner: Object)

 

SuperTcpServerChannelWorker(Object owner)

 

Sub New (owner As Object)

Parameters:

  • owner:

AckWaitTimeout    (declared in SuperTcpChannelWorker)

Defines the timeout, in milliseconds, in which an "acknowledgement" message is expected to be received for a sent request (default is 60,000, 1 minute).

 

property AckWaitTimeout: Int32 read write;

 

Int32 AckWaitTimeout { get; set; }

 

Property AckWaitTimeout As Int32

ClientId    (declared in SuperTcpChannelWorker)

 

property ClientId: Guid read write;

 

Guid ClientId { get; set; }

 

Property ClientId As Guid

Connection

 

property Connection: Connection read;

 

Connection Connection { get; }

 

Property ReadOnly Connection As Connection

DataConnection    (declared in AsyncWorker)

 

property DataConnection: Connection read write;

 

Connection DataConnection { get; set; }

 

Property DataConnection As Connection

DispatchEvents

 

method DispatchEvents(queue: IMessageQueue)

 

void DispatchEvents(IMessageQueue queue)

 

Sub DispatchEvents(queue As IMessageQueue)

Parameters:

  • queue:

Done

 

method Done

 

void Done()

 

Sub Done

IncomingData (SuperTcpPackage)  protected

 

method IncomingData(package: SuperTcpPackage)

 

void IncomingData(SuperTcpPackage package)

 

Sub IncomingData(package As SuperTcpPackage)

Parameters:

  • package:

IncomingData (SuperTcpPackage)  protected    (declared in SuperTcpChannelWorker)

 

method IncomingData(package: SuperTcpPackage)

 

void IncomingData(SuperTcpPackage package)

 

Sub IncomingData(package As SuperTcpPackage)

Parameters:

  • package:

IsServer  protected    (declared in SuperTcpChannelWorker)

This property identifies the server worker class in the decsendants. It is TRUE in the SCServerWorker class and FALSE in the SCClientWorkerclass.

 

property IsServer: Boolean read write;

 

Boolean IsServer { get; set; }

 

Property IsServer As Boolean

LastData  protected    (declared in SuperTcpChannelWorker)

Specifies the time of the last sending or receiving of data.

 

property LastData: DateTime read;

 

DateTime LastData { get; }

 

Property ReadOnly LastData As DateTime

LocalEndPoint

 

property LocalEndPoint: IPEndPoint read;

 

IPEndPoint LocalEndPoint { get; }

 

Property ReadOnly LocalEndPoint As IPEndPoint

MaxPackageLen

 

property MaxPackageLen: Int32 read;

 

Int32 MaxPackageLen { get; }

 

Property ReadOnly MaxPackageLen As Int32

Owner    (declared in AsyncWorker)

 

property Owner: Object read;

 

Object Owner { get; }

 

Property ReadOnly Owner As Object

ReceivedAck  protected

 

method ReceivedAck(id: Int32)

 

void ReceivedAck(Int32 id)

 

Sub ReceivedAck(id As Int32)

Parameters:

  • id:

RemoteEndPoint

 

property RemoteEndPoint: IPEndPoint read;

 

IPEndPoint RemoteEndPoint { get; }

 

Property ReadOnly RemoteEndPoint As IPEndPoint

RemoteMaxPackageLen    (declared in SuperTcpChannelWorker)

Determines the maximum size of data that the other side (client or server) can receive.

 

property RemoteMaxPackageLen: Int32 read;

 

Int32 RemoteMaxPackageLen { get; }

 

Property ReadOnly RemoteMaxPackageLen As Int32

Running    (declared in SuperTcpChannelWorker)

 

property Running: Boolean read;

 

Boolean Running { get; }

 

Property ReadOnly Running As Boolean

ScCmdNoAck_MsgTooLarge    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_MsgTooLarge: Byte = 0;

 

const Byte ScCmdNoAck_MsgTooLarge = 0

 

Dim ScCmdNoAck_MsgTooLarge As Byte = 0

ScCmdNoAck_QueueFull    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_QueueFull: Byte = 3;

 

const Byte ScCmdNoAck_QueueFull = 3

 

Dim ScCmdNoAck_QueueFull As Byte = 3

ScCmdNoAck_ScCmdOptionsSupported    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_ScCmdOptionsSupported: Byte = 255;

 

const Byte ScCmdNoAck_ScCmdOptionsSupported = 255

 

Dim ScCmdNoAck_ScCmdOptionsSupported As Byte = 255

ScCmdNoAck_Timeout    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_Timeout: Byte = 1;

 

const Byte ScCmdNoAck_Timeout = 1

 

Dim ScCmdNoAck_Timeout As Byte = 1

scCmdNoAck_UnknownCommand    (declared in SuperTcpChannelWorker)

 

const scCmdNoAck_UnknownCommand: Byte = 2;

 

const Byte scCmdNoAck_UnknownCommand = 2

 

Dim scCmdNoAck_UnknownCommand As Byte = 2

SendNoAck    (declared in SuperTcpChannelWorker)

This method will inform the other side (client or server) about an error encountered during perfoming a callback (for example if the response message cannot be sent because its size is greater than the other side can receive (greater than RemoteMaxPackageLength)).

 

method SendNoAck(id: Int32; errorCode: Byte)

 

void SendNoAck(Int32 id, Byte errorCode)

 

Sub SendNoAck(id As Int32, errorCode As Byte)

Parameters:

  • id:
  • errorCode:

SendPackage    (declared in SuperTcpChannelWorker)

Sends a package to the other side.

 

method SendPackage(id: Int32; data: array of Byte): Int32

 

Int32 SendPackage(Int32 id, Byte[] data)

 

Function SendPackage(id As Int32, data As array of Byte) As Int32

Parameters:

  • id:
  • data:

ServerChannel

 

property ServerChannel: ServerChannel read;

 

ServerChannel ServerChannel { get; }

 

Property ReadOnly ServerChannel As ServerChannel

Setup

 

method Setup

 

void Setup()

 

Sub Setup

SetupClientConnection  protected

 

method SetupClientConnection

 

void SetupClientConnection()

 

Sub SetupClientConnection

SetupMainLoop  protected    (declared in SuperTcpChannelWorker)

 

method SetupMainLoop

 

void SetupMainLoop()

 

Sub SetupMainLoop

SkipAck    (declared in SuperTcpChannelWorker)

Defines whether "acknowledgement" messages are skipped.

 

property SkipAck: Boolean read write;

 

Boolean SkipAck { get; set; }

 

Property SkipAck As Boolean

TimerCallback  protected

 

method TimerCallback(state: Object)

 

void TimerCallback(Object state)

 

Sub TimerCallback(state As Object)

Parameters:

  • state:

UnknownNoAck  protected    (declared in SuperTcpChannelWorker)

 

method UnknownNoAck(id: Int32; errorCode: Byte)

 

void UnknownNoAck(Int32 id, Byte errorCode)

 

Sub UnknownNoAck(id As Int32, errorCode As Byte)

Parameters:

  • id:
  • errorCode:

WaitingForAck (Int32, SuperTcpEventPackage)  protected

 

method WaitingForAck(id: Int32; value: SuperTcpEventPackage)

 

void WaitingForAck(Int32 id, SuperTcpEventPackage value)

 

Sub WaitingForAck(id As Int32, value As SuperTcpEventPackage)

Parameters:

  • id:
  • value:

WaitingForAck (Int32, SuperTcpEventPackage)  protected    (declared in SuperTcpChannelWorker)

 

method WaitingForAck(id: Int32; value: SuperTcpEventPackage)

 

void WaitingForAck(Int32 id, SuperTcpEventPackage value)

 

Sub WaitingForAck(id As Int32, value As SuperTcpEventPackage)

Parameters:

  • id:
  • value:

 

ScCmdNoAck_MsgTooLarge    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_MsgTooLarge: Byte = 0;

 

const Byte ScCmdNoAck_MsgTooLarge = 0

 

Dim ScCmdNoAck_MsgTooLarge As Byte = 0

ScCmdNoAck_QueueFull    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_QueueFull: Byte = 3;

 

const Byte ScCmdNoAck_QueueFull = 3

 

Dim ScCmdNoAck_QueueFull As Byte = 3

ScCmdNoAck_ScCmdOptionsSupported    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_ScCmdOptionsSupported: Byte = 255;

 

const Byte ScCmdNoAck_ScCmdOptionsSupported = 255

 

Dim ScCmdNoAck_ScCmdOptionsSupported As Byte = 255

ScCmdNoAck_Timeout    (declared in SuperTcpChannelWorker)

 

const ScCmdNoAck_Timeout: Byte = 1;

 

const Byte ScCmdNoAck_Timeout = 1

 

Dim ScCmdNoAck_Timeout As Byte = 1

scCmdNoAck_UnknownCommand    (declared in SuperTcpChannelWorker)

 

const scCmdNoAck_UnknownCommand: Byte = 2;

 

const Byte scCmdNoAck_UnknownCommand = 2

 

Dim scCmdNoAck_UnknownCommand As Byte = 2

 

AckWaitTimeout    (declared in SuperTcpChannelWorker)

Defines the timeout, in milliseconds, in which an "acknowledgement" message is expected to be received for a sent request (default is 60,000, 1 minute).

 

property AckWaitTimeout: Int32 read write;

 

Int32 AckWaitTimeout { get; set; }

 

Property AckWaitTimeout As Int32

ClientId    (declared in SuperTcpChannelWorker)

 

property ClientId: Guid read write;

 

Guid ClientId { get; set; }

 

Property ClientId As Guid

Connection

 

property Connection: Connection read;

 

Connection Connection { get; }

 

Property ReadOnly Connection As Connection

DataConnection    (declared in AsyncWorker)

 

property DataConnection: Connection read write;

 

Connection DataConnection { get; set; }

 

Property DataConnection As Connection

IsServer  protected    (declared in SuperTcpChannelWorker)

This property identifies the server worker class in the decsendants. It is TRUE in the SCServerWorker class and FALSE in the SCClientWorkerclass.

 

property IsServer: Boolean read write;

 

Boolean IsServer { get; set; }

 

Property IsServer As Boolean

LastData  protected    (declared in SuperTcpChannelWorker)

Specifies the time of the last sending or receiving of data.

 

property LastData: DateTime read;

 

DateTime LastData { get; }

 

Property ReadOnly LastData As DateTime

LocalEndPoint

 

property LocalEndPoint: IPEndPoint read;

 

IPEndPoint LocalEndPoint { get; }

 

Property ReadOnly LocalEndPoint As IPEndPoint

MaxPackageLen

 

property MaxPackageLen: Int32 read;

 

Int32 MaxPackageLen { get; }

 

Property ReadOnly MaxPackageLen As Int32

Owner    (declared in AsyncWorker)

 

property Owner: Object read;

 

Object Owner { get; }

 

Property ReadOnly Owner As Object

RemoteEndPoint

 

property RemoteEndPoint: IPEndPoint read;

 

IPEndPoint RemoteEndPoint { get; }

 

Property ReadOnly RemoteEndPoint As IPEndPoint

RemoteMaxPackageLen    (declared in SuperTcpChannelWorker)

Determines the maximum size of data that the other side (client or server) can receive.

 

property RemoteMaxPackageLen: Int32 read;

 

Int32 RemoteMaxPackageLen { get; }

 

Property ReadOnly RemoteMaxPackageLen As Int32

Running    (declared in SuperTcpChannelWorker)

 

property Running: Boolean read;

 

Boolean Running { get; }

 

Property ReadOnly Running As Boolean

ServerChannel

 

property ServerChannel: ServerChannel read;

 

ServerChannel ServerChannel { get; }

 

Property ReadOnly ServerChannel As ServerChannel

SkipAck    (declared in SuperTcpChannelWorker)

Defines whether "acknowledgement" messages are skipped.

 

property SkipAck: Boolean read write;

 

Boolean SkipAck { get; set; }

 

Property SkipAck As Boolean

 

constructor

 

constructor(owner: Object)

 

SuperTcpServerChannelWorker(Object owner)

 

Sub New (owner As Object)

Parameters:

  • owner:

DispatchEvents

 

method DispatchEvents(queue: IMessageQueue)

 

void DispatchEvents(IMessageQueue queue)

 

Sub DispatchEvents(queue As IMessageQueue)

Parameters:

  • queue:

Done

 

method Done

 

void Done()

 

Sub Done

IncomingData (SuperTcpPackage)  protected

 

method IncomingData(package: SuperTcpPackage)

 

void IncomingData(SuperTcpPackage package)

 

Sub IncomingData(package As SuperTcpPackage)

Parameters:

  • package:

IncomingData (SuperTcpPackage)  protected    (declared in SuperTcpChannelWorker)

 

method IncomingData(package: SuperTcpPackage)

 

void IncomingData(SuperTcpPackage package)

 

Sub IncomingData(package As SuperTcpPackage)

Parameters:

  • package:

ReceivedAck  protected

 

method ReceivedAck(id: Int32)

 

void ReceivedAck(Int32 id)

 

Sub ReceivedAck(id As Int32)

Parameters:

  • id:

SendNoAck    (declared in SuperTcpChannelWorker)

This method will inform the other side (client or server) about an error encountered during perfoming a callback (for example if the response message cannot be sent because its size is greater than the other side can receive (greater than RemoteMaxPackageLength)).

 

method SendNoAck(id: Int32; errorCode: Byte)

 

void SendNoAck(Int32 id, Byte errorCode)

 

Sub SendNoAck(id As Int32, errorCode As Byte)

Parameters:

  • id:
  • errorCode:

SendPackage    (declared in SuperTcpChannelWorker)

Sends a package to the other side.

 

method SendPackage(id: Int32; data: array of Byte): Int32

 

Int32 SendPackage(Int32 id, Byte[] data)

 

Function SendPackage(id As Int32, data As array of Byte) As Int32

Parameters:

  • id:
  • data:

Setup

 

method Setup

 

void Setup()

 

Sub Setup

SetupClientConnection  protected

 

method SetupClientConnection

 

void SetupClientConnection()

 

Sub SetupClientConnection

SetupMainLoop  protected    (declared in SuperTcpChannelWorker)

 

method SetupMainLoop

 

void SetupMainLoop()

 

Sub SetupMainLoop

TimerCallback  protected

 

method TimerCallback(state: Object)

 

void TimerCallback(Object state)

 

Sub TimerCallback(state As Object)

Parameters:

  • state:

UnknownNoAck  protected    (declared in SuperTcpChannelWorker)

 

method UnknownNoAck(id: Int32; errorCode: Byte)

 

void UnknownNoAck(Int32 id, Byte errorCode)

 

Sub UnknownNoAck(id As Int32, errorCode As Byte)

Parameters:

  • id:
  • errorCode:

WaitingForAck (Int32, SuperTcpEventPackage)  protected

 

method WaitingForAck(id: Int32; value: SuperTcpEventPackage)

 

void WaitingForAck(Int32 id, SuperTcpEventPackage value)

 

Sub WaitingForAck(id As Int32, value As SuperTcpEventPackage)

Parameters:

  • id:
  • value:

WaitingForAck (Int32, SuperTcpEventPackage)  protected    (declared in SuperTcpChannelWorker)

 

method WaitingForAck(id: Int32; value: SuperTcpEventPackage)

 

void WaitingForAck(Int32 id, SuperTcpEventPackage value)

 

Sub WaitingForAck(id As Int32, value As SuperTcpEventPackage)

Parameters:

  • id:
  • value: