WSServer Component
Properties Methods Events Configuration Settings Errors
The WSServer component is used to create a WebSocket server.
Syntax
nsoftware.IPWorksWS.Wsserver
Remarks
The WSServer component provides an easy way to accept connections from WebSocket clients and transfer data.
The WSServer component is a server that accepts incoming WebSocket connections and provides an easy way to send and receive data over the connection.
To begin using the component first specify a valid value for LocalPort. This is the port on which incoming connections will be accepted. To begin listening set Listening to True.
When a client connects the WebSocketOpenRequest event will fire. To accept the connection simply allow the event to complete. To reject the request set the StatusCode parameter to an HTTP error code (such as 401).
Once the connection is received incoming data will be provide through the DataIn event. To send data to a client you may use the Send, SendText, or SendFile methods. You may also set DataToSend.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| ConnectionBacklog | The maximum number of pending connections maintained by the TCP/IP subsystem. |
| Connections | A collection of currently connected WebSocket clients. |
| DefaultTimeout | An initial timeout value to be used by incoming connections. |
| Listening | If True, the component accepts incoming connections on LocalPort. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component listens. |
| SSLAuthenticateClients | If true, the server asks the client(s) for a certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| UseSSL | Determines if SSL is negotiated with incoming connections. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Disconnect | Disconnect the specified client. |
| DoEvents | Processes events from the internal message queue. |
| Interrupt | Interrupts a synchronous send to the remote host. |
| Send | Sends binary data to the client. |
| SendFile | Send file to the remote host. |
| SendText | Sends text data to the client. |
| Shutdown | Shuts down the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Connected | Fired when a WebSocket is successfully opened. |
| ConnectionRequest | Fired when a request for connection comes from a remote host. |
| DataIn | Fired when data is received. |
| Disconnected | Fired when a WebSocket connection is disconnected. |
| Error | Information about errors during data delivery. |
| ReadyToSend | Fired when the component is ready to send data. |
| SSLClientAuthentication | Fired when the client presents its credentials to the server. |
| SSLStatus | Shows the progress of the secure connection. |
| WebSocketOpenRequest | Fired when a client attempts to open a WebSocket. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| WaitForCloseResponse | Determines whether or not the component will forcibly close a connection. |
| BufferMessage | Indicates whether or not the entire message is buffered before firing the DataIn event. |
| DisconnectStatusCode | Specifies the status code when closing a connection. |
| DisconnectStatusDescription | Specifies the message associated with the disconnect status code. |
| MaxFrameSize | Specifies the maximum size of the outgoing message in bytes before fragmentation occurs. |
| BindExclusively | Whether or not the component considers a local port reserved for exclusive use. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| MaxConnections | The maximum number of connections available. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| RecordLength[ConnectionId] | The length of received data records. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| CodePage | The system code page used for Unicode to Multibyte translations. |