C# Class LitDev.LDServer

Show file Open project: litdev1/LitDev Class Usage Examples

Public Properties

Property	Type	Description
_ClientMessageDelegate	SmallBasicCallback
lastClient	string
lastClientConnected	string
lastClientDisconnected	string
lastClientMessage	string

Private Properties

Property	Type	Description
ClientMessageDelegate	void
GetClient	Client
GetClient	Client
Listen	void
MonitorClients	void
NextClient	string
RemoveClient	Client
Send	string

Public Methods

Method	Description
Close ( Primitive clientName ) : Primitive	Disconnect and close (End) a client.
Disconnect ( Primitive clientName ) : Primitive	Disconnect a client.
GetClients ( ) : Primitive	Get a list of current connected clients.
SendMessage ( Primitive clientName, Primitive message ) : Primitive	Send a message to a client.
Start ( Primitive auto ) : Primitive	Start the server.
Stop ( ) : Primitive	Stop the current server and close all clients.

Private Methods

Method	Description
ClientMessageDelegate ( string client, string message ) : void
GetClient ( EndPoint endPoint ) : Client
GetClient ( string name ) : Client
Listen ( ) : void
MonitorClients ( ) : void
NextClient ( ) : string
RemoveClient ( string name ) : Client
Send ( string clientName, string message ) : string

Method Details

Close() public static method

Disconnect and close (End) a client.

public static Close ( Primitive clientName ) : Primitive
clientName	Primitive	The client name, usually Client1, Client2 etc. /// A list of current clients can be obtained from the method GetClients or found from the ClientConnected event.
return	Primitive

Disconnect() public static method

Disconnect a client.

public static Disconnect ( Primitive clientName ) : Primitive
clientName	Primitive	The client name, usually Client1, Client2 etc. /// A list of current clients can be obtained from the method GetClients or found from the ClientConnected event.
return	Primitive

GetClients() public static method

Get a list of current connected clients.

public static GetClients ( ) : Primitive
return	Primitive

SendMessage() public static method

Send a message to a client.

public static SendMessage ( Primitive clientName, Primitive message ) : Primitive
clientName	Primitive	The client name, usually Client1, Client2 etc. /// A list of current clients can be obtained from the method GetClients or found from the ClientConnected event.
message	Primitive	The message may be any variable including an array.
return	Primitive

Start() public static method

Start the server.

public static Start ( Primitive auto ) : Primitive
auto	Primitive	Enable auto message passing "True" or "False". /// If this is used (recommended) then all client data is passed via server to all other clients, /// and no processing of send and receive events is required. /// The data is updated to arrays of data (indexed by client name) that is returned from the client Update methods. /// The auto option should be the same for server and all clients.
return	Primitive

Stop() public static method

Stop the current server and close all clients.

public static Stop ( ) : Primitive
return	Primitive

Property Details

_ClientMessageDelegate public static property

public static SmallBasicCallback _ClientMessageDelegate
return	SmallBasicCallback

lastClient public static property

public static string lastClient
return	string

lastClientConnected public static property

public static string lastClientConnected
return	string

lastClientDisconnected public static property

public static string lastClientDisconnected
return	string

lastClientMessage public static property

public static string lastClientMessage
return	string