TsgcWSPServer_Files › Events

TsgcWSPServer_Files Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Lifecycle

Name	Description
OnConnect	Fired when a client successfully connects to the server.
OnDisconnect	Fired when a client disconnects from the server.
OnError	Fired when a protocol-level error is reported for a connection.
OnException	Fired when an unhandled exception is raised while processing a connection.

Messaging

Name	Description
OnMessage	Fired when a plain text message is received from a client over the Files subprotocol.
OnBinary	Fired when a raw binary frame is received from a client.
OnFragmented	Fired when a fragmented WebSocket frame is received from a client.
OnRawMessage	Fired before the subprotocol parses a text message, allowing custom handling.

Subscriptions

Name	Description
OnBeforeSubscription	Fired before a client is subscribed to a channel, allowing the server to accept or reject the subscription.
OnSubscription	Fired after a client has been successfully subscribed to a channel.
OnUnSubscription	Fired after a client has been unsubscribed from a channel.

Receive

Name	Description
OnFileReceivedAuthorization	Fired before an incoming file is accepted, allowing authorization and rename of the destination file.
OnFileReceived	Fired when a file has been successfully received from a client.
OnFileReceivedFragment	Fired when a fragment of a file is received; useful to report progress and allow cancellation.
OnFileReceivedError	Fired when an error occurs while receiving a file from a client.

Send

Name	Description
OnFileBeforeSent	Fired before a file is sent, allowing inspection and customization of the outgoing file metadata.
OnFileSentFragmentRequest	Fired when the receiver requests the next fragment under QoS Level 2; allows cancelling the transfer.
OnFileSentAcknowledgment	Fired when the receiver acknowledges a sent fragment under QoS Level 1 or 2.
OnFileSent	Fired when a file has been successfully delivered to the client.
OnFileSentError	Fired when an error occurs while sending a file to a client.

All Events (alphabetical)

Name	Description
OnBeforeSubscription	Fired before a client is subscribed to a channel, allowing the server to accept or reject the subscription.
OnBinary	Fired when a raw binary frame is received from a client.
OnConnect	Fired when a client successfully connects to the server.
OnDisconnect	Fired when a client disconnects from the server.
OnError	Fired when a protocol-level error is reported for a connection.
OnException	Fired when an unhandled exception is raised while processing a connection.
OnFileBeforeSent	Fired before a file is sent, allowing inspection and customization of the outgoing file metadata.
OnFileReceived	Fired when a file has been successfully received from a client.
OnFileReceivedAuthorization	Fired before an incoming file is accepted, allowing authorization and rename of the destination file.
OnFileReceivedError	Fired when an error occurs while receiving a file from a client.
OnFileReceivedFragment	Fired when a fragment of a file is received; useful to report progress and allow cancellation.
OnFileSent	Fired when a file has been successfully delivered to the client.
OnFileSentAcknowledgment	Fired when the receiver acknowledges a sent fragment under QoS Level 1 or 2.
OnFileSentError	Fired when an error occurs while sending a file to a client.
OnFileSentFragmentRequest	Fired when the receiver requests the next fragment under QoS Level 2; allows cancelling the transfer.
OnFragmented	Fired when a fragmented WebSocket frame is received from a client.
OnMessage	Fired when a plain text message is received from a client over the Files subprotocol.
OnRawMessage	Fired before the subprotocol parses a text message, allowing custom handling.
OnSubscription	Fired after a client has been successfully subscribed to a channel.
OnUnSubscription	Fired after a client has been unsubscribed from a channel.