TsgcWSPClient_Files › Events

TsgcWSPClient_Files Events

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

Lifecycle

Name	Description
OnConnect	Fires after the WebSocket handshake completes and the Files subprotocol is ready to transfer files.
OnDisconnect	Fires when the transport connection drops; the subprotocol stops its QoS timer and optionally clears the pending streams.
OnError	Fires for transport-level errors reported by the underlying sgcWebSocket client.
OnException	Fires when an unhandled exception is raised inside the subprotocol worker or QoS timer thread.

Messaging

Name	Description
OnMessage	Fires when a plain text message arrives inside a Files subprotocol envelope.
OnBinary	Fires when a raw binary frame arrives through the Files subprotocol transport.
OnFragmented	Fires for every fragmented WebSocket frame passing through the Files subprotocol transport.
OnRawMessage	Fires with the untouched incoming text before the subprotocol parses it; set Handled to stop default processing.

Subscriptions

Name	Description
OnSubscription	Fires when the server confirms a channel subscription requested with Subscribe.
OnUnSubscription	Fires when the server confirms that a channel subscription has been cancelled.

Receive

Name	Description
OnFileReceivedAuthorization	Fires when a qosLevel2 file is about to be saved, letting you accept or reject it and optionally rename the destination.
OnFileReceived	Fires when an incoming file has been fully received and persisted to disk.
OnFileReceivedFragment	Fires every time a new fragment of an incoming file has been written to disk; ideal for progress indicators.
OnFileReceivedError	Fires when an error occurs while receiving a file.

Send

Name	Description
OnFileBeforeSent	Fires just before the file header leaves the client, letting you inspect or tweak the outgoing TsgcWSMessageFile.
OnFileSentFragmentRequest	Fires each time the client is about to send a new outbound file fragment; ideal for upload progress and cancellation.
OnFileSentAcknowledgment	Fires when the server acknowledges processing of an outbound file fragment under qosLevel1 or qosLevel2.
OnFileSent	Fires when the server confirms that a file has been fully received.
OnFileSentError	Fires when the upload of a file fails either locally or after a rejection from the server.

All Events (alphabetical)

Name	Description
OnBinary	Fires when a raw binary frame arrives through the Files subprotocol transport.
OnConnect	Fires after the WebSocket handshake completes and the Files subprotocol is ready to transfer files.
OnDisconnect	Fires when the transport connection drops; the subprotocol stops its QoS timer and optionally clears the pending streams.
OnError	Fires for transport-level errors reported by the underlying sgcWebSocket client.
OnException	Fires when an unhandled exception is raised inside the subprotocol worker or QoS timer thread.
OnFileBeforeSent	Fires just before the file header leaves the client, letting you inspect or tweak the outgoing TsgcWSMessageFile.
OnFileReceived	Fires when an incoming file has been fully received and persisted to disk.
OnFileReceivedAuthorization	Fires when a qosLevel2 file is about to be saved, letting you accept or reject it and optionally rename the destination.
OnFileReceivedError	Fires when an error occurs while receiving a file.
OnFileReceivedFragment	Fires every time a new fragment of an incoming file has been written to disk; ideal for progress indicators.
OnFileSent	Fires when the server confirms that a file has been fully received.
OnFileSentAcknowledgment	Fires when the server acknowledges processing of an outbound file fragment under qosLevel1 or qosLevel2.
OnFileSentError	Fires when the upload of a file fails either locally or after a rejection from the server.
OnFileSentFragmentRequest	Fires each time the client is about to send a new outbound file fragment; ideal for upload progress and cancellation.
OnFragmented	Fires for every fragmented WebSocket frame passing through the Files subprotocol transport.
OnMessage	Fires when a plain text message arrives inside a Files subprotocol envelope.
OnRawMessage	Fires with the untouched incoming text before the subprotocol parses it; set Handled to stop default processing.
OnSubscription	Fires when the server confirms a channel subscription requested with Subscribe.
OnUnSubscription	Fires when the server confirms that a channel subscription has been cancelled.