SimpleWebSocketServer Library  v1.0.1
A simple to use websocket with a very easy way to get it to work, just requires four lines of code.
SimpleWebSocketServerLibrary.WebSocketEventArg Class Reference

Contains information about a occured event. More...

+ Inheritance diagram for SimpleWebSocketServerLibrary.WebSocketEventArg:
+ Collaboration diagram for SimpleWebSocketServerLibrary.WebSocketEventArg:

Properties

bool isText = false [get, set]
 Is true when message is a text message. More...
 
bool isBinary = false [get, set]
 Is true when message is a binairy message. More...
 
bool isClosed = false [get, set]
 Is true when a client send a close message. More...
 
bool isOpen = false [get, set]
 Is true when a client has connected More...
 
bool isPing = false [get, set]
 Is true when message from client is a ping message. More...
 
bool isPong = false [get, set]
 Is true when message from client is a pong message. More...
 
byte [] data [get, set]
 Contains the extra data send by a client. More...
 
UInt64 messageLength = 0 [get, set]
 Message length in bytes. More...
 
string clientId [get, set]
 Client ID set by client or generated by server when connecting to websocket server. More...
 
string clientBaseUrl [get, set]
 Client baseurl used when connecting. More...
 
string errorMessage [get, set]
 Error message in case an error occurred. More...
 

Detailed Description

Contains information about a occured event.

Definition at line 8 of file WebsocketEventArg.cs.

Property Documentation

◆ clientBaseUrl

string SimpleWebSocketServerLibrary.WebSocketEventArg.clientBaseUrl
getset

Client baseurl used when connecting.

Definition at line 49 of file WebsocketEventArg.cs.

◆ clientId

string SimpleWebSocketServerLibrary.WebSocketEventArg.clientId
getset

Client ID set by client or generated by server when connecting to websocket server.

Definition at line 45 of file WebsocketEventArg.cs.

◆ data

byte [] SimpleWebSocketServerLibrary.WebSocketEventArg.data
getset

Contains the extra data send by a client.

Definition at line 37 of file WebsocketEventArg.cs.

◆ errorMessage

string SimpleWebSocketServerLibrary.WebSocketEventArg.errorMessage
getset

Error message in case an error occurred.

Definition at line 53 of file WebsocketEventArg.cs.

◆ isBinary

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isBinary = false
getset

Is true when message is a binairy message.

Definition at line 17 of file WebsocketEventArg.cs.

◆ isClosed

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isClosed = false
getset

Is true when a client send a close message.

Definition at line 21 of file WebsocketEventArg.cs.

◆ isOpen

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isOpen = false
getset

Is true when a client has connected

Definition at line 25 of file WebsocketEventArg.cs.

◆ isPing

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isPing = false
getset

Is true when message from client is a ping message.

Definition at line 29 of file WebsocketEventArg.cs.

◆ isPong

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isPong = false
getset

Is true when message from client is a pong message.

Definition at line 33 of file WebsocketEventArg.cs.

◆ isText

bool SimpleWebSocketServerLibrary.WebSocketEventArg.isText = false
getset

Is true when message is a text message.

Definition at line 13 of file WebsocketEventArg.cs.

◆ messageLength

UInt64 SimpleWebSocketServerLibrary.WebSocketEventArg.messageLength = 0
getset

Message length in bytes.

Definition at line 41 of file WebsocketEventArg.cs.


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