TMS FNC WebSocket API Reference

Use this reference for exact Delphi API contracts. Start from the component pages for purpose, setup, and task guides; use the class and member pages here for signatures, defaults, behavior notes, and event contracts.

Entry Points

Route	Use when
Components	You want component purpose, screenshots, guide links, and the component API map.
Product guides	You want cross-cutting workflows before drilling into component APIs.
Product overview	You want frameworks, dependencies, IDE support, and release notes.

Component Summary

Component	Use for
TMS FNC WebSocket Client	Cross-platform WebSocket client component for connecting to and exchanging messages with WebSocket servers.
TMS FNC WebSocket Server	Cross-platform WebSocket server component for accepting and managing multiple simultaneous client connections.
TMS FNC WhatsApp Receiver	WebSocket-based client component for receiving and parsing structured WhatsApp Business API webhook messages.
TMS FNC WhatsApp Server	WebSocket server component specialized for forwarding and handling WhatsApp Business API webhook callbacks.

API By Component

TMS FNC WebSocket Client

Classes And Records

Type	Description
`TTMSFNCCustomWebsocketClient`	Base WebSocket client component. Connects to a server, performs the upgrade handshake, sends and receives text, binary, ping, pong, and close frames, and surfaces connection lifecycle events. Surface the published properties through the TTMSFNCWebsocketClient descendant for design-time use.
`TTMSFNCWebSocketBitConverter`	Provides low-level conversion helpers between typed values and raw byte buffers, used when serializing and deserializing frame data.
`TTMSFNCWebSocketClientConnection`	Represents a single client-side WebSocket connection built on top of a TCP client. Reads incoming frames, exposes peer information, and tracks whether the handshake has completed.
`TTMSFNCWebSocketConnection`	Represents a single peer connection, handling incoming frames and providing methods to send text, binary, and control data over the protocol.
`TTMSFNCWebSocketException`	Base exception type raised for WebSocket protocol and processing errors.
`TTMSFNCWebSocketFrame`	Represents a single protocol frame, including its opcode, flags, masking state and payload, and provides serialization to and from the network byte buffer.
`TTMSFNCWebSocketHandshakeException`	Exception raised when the connection upgrade handshake fails or is rejected.
`TTMSFNCWebSocketHandshakeRequest`	Represents the client handshake request sent to upgrade an HTTP connection to a WebSocket connection. Holds the target port and any extra headers, and serializes the request line and headers to a string list.
`TTMSFNCWebSocketHandshakeResponse`	Holds the parsed handshake response returned by the server, exposing the individual negotiated header values and the raw header list.
`TTMSFNCWebSocketMessageDriver`	Base class for drivers that monitor a set of client connections for incoming data and dispatch it. Maintains the connection list and the poll interval; concrete drivers implement how reading is scheduled.
`TTMSFNCWebSocketRequest`	Holds the parsed details of the upgrade handshake request, exposing the requested resource and the relevant handshake headers.
`TTMSFNCWebSocketThreadedMessageDriver`	Default message driver. Runs a background thread that polls the registered sockets for available data and dispatches incoming frames.
`TTMSFNCWebsocketClient`	WebSocket client component for use at design time. Publishes the connection settings and events of TTMSFNCCustomWebsocketClient so they can be configured in the IDE.

Type	Kind	Description
`TTMSFNCWebSocketBinDataEvent`	Event type	Signature for events raised when binary data is received over a connection.
`TTMSFNCWebSocketClientCreateIOHandlerEvent`	Event type	Signature of the event fired when a custom I/O handler may be supplied for a secure connection before connecting.
`TTMSFNCWebSocketConnectEvent`	Event type	Signature for events raised when a connection is established.
`TTMSFNCWebSocketControlEvent`	Event type	Signature for events raised when a control frame (ping, pong or close) is received.
`TTMSFNCWebSocketDisconnectEvent`	Type alias	Signature for events raised when a connection is closed; aliases the general connection notification event.
`TTMSFNCWebSocketDriverErrorEvent`	Event type	Signature of the event fired when the background message driver encounters an error while reading connections.
`TTMSFNCWebSocketFrameType`	Enum	Identifies the position of a frame within a fragmented message sequence.
`TTMSFNCWebSocketFrameTypes`	Type alias	Set of frame position flags describing where a received frame sits in a fragmented message.
`TTMSFNCWebSocketIncomingResult`	Enum	Result of a check for incoming data on a connection.
`TTMSFNCWebSocketMessageEvent`	Event type	Signature for events raised when a complete text message is received.
`TTMSFNCWebSocketNotifyEvent`	Event type	Signature for connection notification events that carry only the affected connection.
`TTMSFNCWebSocketTLSVersion`	Enum	(undocumented)
`TTMSFNCWebSocketTLSVersions`	Type alias	(undocumented)
`TTMSFNCWebsocketClientHandShakeEvent`	Event type	Signature of the event fired just before the handshake request is sent, allowing the headers to be inspected or adjusted.
`TTMSFNCWebsocketClientHandshakeResponseEvent`	Event type	Signature of the event fired when the server handshake response has been received and validated, allowing the connection to be accepted or rejected.
`TTMSFNCWebsocketOption`	Enum	Behavioral options that adjust how a connection assembles frames, validates the handshake, and replies to control frames.

TMS FNC WebSocket Server

Classes And Records

Type	Description
`TTMSFNCCustomWebSocketServer`	Base class for the WebSocket server component. Listens on a configurable port, performs the protocol handshake, tracks active connections, and raises events as messages and control frames are received. Supports secure connections, broadcasting, and targeted sends.
`TTMSFNCWebSocketConnections`	A list that holds the active server connections.
`TTMSFNCWebSocketHTTPServer`	The HTTP server that listens for incoming requests and upgrades matching requests to WebSocket connections.
`TTMSFNCWebSocketServer`	WebSocket server component. Publishes the configuration properties and events of TTMSFNCCustomWebSocketServer so they can be set at design time, and listens for connections to exchange messages and control frames with connected clients.
`TTMSFNCWebSocketServerConnection`	Represents a single client connection accepted by the server. Stores per-connection state such as user data and handshake status, and exposes events to control acceptance and react to a completed handshake.

Type	Kind	Description
`TTMSFNCWebSocketAllowConnectionEvent`	Event type	Event fired after a connection request has been validated, allowing the handler to accept or reject the incoming connection.
`TTMSFNCWebSocketHandshakeSentEvent`	Event type	Event fired after the handshake response has been sent to a connection, indicating the connection is ready to exchange messages.
`TTMSFNCWebSocketSendToCallBack`	Event type	Predicate used to select the connections a broadcast or disconnect operation applies to.
`TTMSFNCWebSocketServerCreateIOHandlerEvent`	Event type	Event fired to let the application supply a custom secure I/O handler instead of the default one.
`TTMSFNCWebSocketServerGetSSLPasswordEvent`	Event type	Event fired when the password protecting an SSL certificate or key file is required.

TMS FNC WhatsApp Receiver

Classes And Records

Type	Description
`TTMSFNCCustomWhatsAppReceiver`	Base WebSocket client that receives incoming WhatsApp messages, parses them into a TTMSFNCWhatsAppReceiverMessage, and raises a notification for each parsed message. Use the published descendant in applications.
`TTMSFNCWhatsAppReceiver`	WebSocket client component that connects to an endpoint and surfaces incoming WhatsApp messages through the `OnWhatsAppMessageReceived` event.
`TTMSFNCWhatsAppReceiverContact`	Represents a single shared contact card with its name, organization, birthday, and collections of addresses, emails, phones, and URLs.
`TTMSFNCWhatsAppReceiverContactAddress`	Holds a single postal address belonging to a shared contact.
`TTMSFNCWhatsAppReceiverContactAddresses`	Owns and manages the collection of postal addresses for a shared contact.
`TTMSFNCWhatsAppReceiverContactEmail`	Holds a single email address belonging to a shared contact.
`TTMSFNCWhatsAppReceiverContactEmails`	Owns and manages the collection of email addresses for a shared contact.
`TTMSFNCWhatsAppReceiverContactName`	Holds the structured name parts of a shared contact.
`TTMSFNCWhatsAppReceiverContactOrganization`	Holds the organization details of a shared contact.
`TTMSFNCWhatsAppReceiverContactPhone`	Holds a single phone number belonging to a shared contact.
`TTMSFNCWhatsAppReceiverContactPhones`	Owns and manages the collection of phone numbers for a shared contact.
`TTMSFNCWhatsAppReceiverContactURL`	Holds a single website URL belonging to a shared contact.
`TTMSFNCWhatsAppReceiverContactURLs`	Owns and manages the collection of website URLs for a shared contact.
`TTMSFNCWhatsAppReceiverContacts`	Owns and manages the collection of shared contacts carried by a message.
`TTMSFNCWhatsAppReceiverLocation`	Describes a geographic location carried by a location message.
`TTMSFNCWhatsAppReceiverMedia`	Describes a media attachment such as an image, audio, document, video, or sticker.
`TTMSFNCWhatsAppReceiverMessage`	Represents a fully parsed incoming message, exposing the sender, metadata, and the typed payload (text, media, location, or contacts) according to `MessageType`.
`TTMSFNCWhatsAppReceiverMessageFrom`	Identifies the sender of a received message.
`TTMSFNCWhatsAppReceiverText`	Holds the textual body of a text message.

Type	Kind	Description
`TTMSFNCCustomWhatsAppMessageReceivedEvent`	Event type	Notifies that an incoming message has been received and parsed.
`TTMSFNCWhatsAppReceiverContactPhoneType`	Enum	Categorizes a contact phone number by its usage.
`TTMSFNCWhatsAppReceiverContactType`	Enum	Categorizes a contact detail such as an address, email, or URL as home or work.

TMS FNC WhatsApp Server

Classes And Records

Type	Description
`TTMSFNCCustomWhatsAppServer`	Base server that receives messaging webhook callbacks over HTTP, validates the verification handshake, and relays inbound payloads to connected WebSocket clients.
`TTMSFNCWhatsAppServer`	Ready-to-use server component that receives messaging webhook callbacks over HTTP and relays inbound payloads to connected WebSocket clients.

Type	Kind	Description
`TTMSFNCWhatsAppServerMessageEvent`	Event type	Occurs when a raw inbound HTTP message is received from the messaging webhook, before it is broadcast to connected clients.

See Also