sgcWebSockets technical documents

Eighty-six reference documents, one for every client, server, protocol and API integration in the suite. Each one follows the same shape: what the component does, the properties, methods and events it exposes, a quick start in Object Pascal, C++ and C#, worked scenarios with code you can paste, and the sources every claim was built from. Read one in the browser, or take the PDF.

One document per component

The set covers every component that ships in sgcWebSockets, across Delphi, C++ Builder, Lazarus and .NET. It is generated from the same material as the product pages and the online help, and it is regenerated with each release.

What is in a document

An overview, an at-a-glance box naming the edition and the platforms the component runs on, the feature list, then the technical specification split into main properties, main methods and public events. After that a quick start for Delphi VCL and FireMonkey, for C++ Builder and for .NET, several worked scenarios, and a closing list of every source consulted.

Who it is for

Two readers. Somebody deciding whether a component already covers a job, who wants the whole surface on one page before committing to it. And somebody already using it, who wants a property list and a working example without walking a help tree.

HTML and PDF hold the same content

Every document exists twice. The HTML copy is what search engines index and what you can link into. The PDF is laid out for A4, keeps its page breaks and its cover, and is the copy to file with a specification or read on a machine that is offline.

How this fits the rest of the site

A product page explains what a component is for and why you would reach for it. These documents explain how it behaves. The online help is the exhaustive per-property reference. Start on the product page, plan the code here, open the help for the last detail.

Nine sections, eighty-six documents

Each section has an index page of its own, so a document is never more than two clicks from here. The full listing follows below.

AI and LLM

8 documents · ai/

Components that talk to language models and vector stores: the provider clients, the chatbot and translator front ends, embeddings, and both sides of the Model Context Protocol.

Browse AI and LLM

API integrations

26 documents · apis/

Ready-made clients for third-party services. Mostly WebSocket market data and trading feeds, plus the messaging platforms and the two SignalR dialects.

Browse API integrations

Core components

12 documents · components/

The WebSocket client and server themselves, in Delphi and in .NET, together with the resilience components that guard them and the scaling components that put several servers behind one address.

Browse Core components

DataSnap and WebBroker

3 documents · datasnap/

Bridges that host an existing WebBroker or DataSnap application on an sgcWebSockets server, so one executable answers REST, WebSocket and HTTP/2 on the same port.

Browse DataSnap and WebBroker

HTTP, HTTP/2 and authentication

14 documents · http/

The HTTP/2 client and server, gRPC, the OAuth2 and JWT components on both sides, WebAuthn, and the push and queue services reached over plain HTTP.

Browse HTTP, HTTP/2 and authentication

IoT brokers

2 documents · iot/

MQTT clients preconfigured for the two managed IoT brokers, with the authentication each one insists on already wired up.

Browse IoT brokers

Peer to peer

8 documents · p2p/

The NAT traversal stack: STUN, TURN and ICE as client and server, the UDP transports underneath them, and the Delphi side of RTCPeerConnection.

Browse Peer to peer

Messaging protocols

12 documents · protocols/

WebSocket subprotocols and message brokers: MQTT, both AMQP versions, STOMP against two brokers, WAMP, WebRTC signalling, and the five custom sgc subprotocols.

Browse Messaging protocols

Server APIs

1 document · server-apis/

Server-side components that answer a browser or platform specification rather than call somebody else’s service.

Browse Server APIs

AI and LLM

Components that talk to language models and vector stores: the provider clients, the chatbot and translator front ends, embeddings, and both sides of the Model Context Protocol.

Anthropic ComponentHigh-level Anthropic Claude API client — Messages, streaming, tool use, vision and structured-output JSON schema.
AI ChatBotHigh-level ChatBot component — wraps OpenAI, Anthropic, Gemini or local LLMs in a one-line conversational front-end.
AI EmbeddingsEmbeddings generator and consumer for vector search — text-embedding-ada-002, text-embedding-3-large and compatible providers.
MCP ClientModel Context Protocol (MCP) client — connect Delphi apps to any MCP server (resources, tools, prompts).
MCP ServerModel Context Protocol (MCP) server — expose your Delphi resources, tools and prompts to any MCP client (Claude, ChatGPT, IDEs).
OpenAI ComponentHigh-level OpenAI HTTP API client — chat completions, responses, embeddings, images, audio, files, fine-tuning, batches and assistants.
Pinecone Vector DatabasePinecone client — upsert, query and delete vectors in a managed Pinecone serverless or pod-based index from Delphi.
AI TranslatorHigh-level translator component — translate text between languages with OpenAI, Anthropic or Gemini providers.

Section index: AI and LLM technical documents.

API integrations

Ready-made clients for third-party services. Mostly WebSocket market data and trading feeds, plus the messaging platforms and the two SignalR dialects.

3Commas API3Commas trading-bot WebSocket and REST client for Delphi — DMC streams plus account, deal and bot endpoints.
Anthropic APIAnthropic Claude API client — Messages, streaming, tool use, vision and structured-output JSON schema for Delphi.
Binance APIBinance spot and futures WebSocket and REST client — public streams, user data and authenticated trading.
Bitfinex APIBitfinex v2 WebSocket client — public tickers, books and trades plus authenticated account and order streams.
Bitmex APIBitmex WebSocket and REST client — public market data plus authenticated trading and position streams.
Bitstamp APIBitstamp WebSocket client — live order book, trade and ticker streams for every supported instrument.
Blockchain.com APIBlockchain.com market-data WebSocket client — subscribe to live tickers, books and trades via the generic TsgcWebSocketClient.
Bybit APIBybit v5 unified WebSocket and REST client — spot, linear, inverse and options market data plus authenticated trading.
CEX.io APICEX.io WebSocket and REST client — public and authenticated channels for the CEX.io exchange.
Coinbase Advanced Trade APICoinbase Advanced Trade WebSocket and REST client — public market data plus authenticated trading on Coinbase Exchange.
Cryptohopper APICryptohopper trading-bot REST client — accounts, hoppers, orders and signals for Delphi.
Discord APIDiscord Gateway WebSocket client — receive bot events, manage guilds and send REST commands from Delphi.
Huobi (HTX) APIHuobi / HTX WebSocket and REST client — global spot and derivatives market-data plus authenticated trading.
Kraken APIKraken WebSocket v2 and REST client — public market-data plus authenticated account, order and balance streams.
KuCoin APIKuCoin WebSocket and REST client — spot and futures market-data plus authenticated trading.
MEXC APIMEXC WebSocket and REST client — spot and futures market data plus authenticated trading.
OKX APIOKX v5 WebSocket and REST client — unified spot, futures, perpetual and options market data plus authenticated trading.
OpenAI Realtime APIOpenAI Realtime WebSocket client — bidirectional audio, function-calling and tool-use sessions with GPT-4o models.
Pusher Channels APIPusher Channels client for Delphi — public, private and presence channels with WebSocket transport.
RCON ProtocolSource RCON protocol client — Valve / Source-engine remote console TCP client for Delphi.
SignalR Classic APISignalR classic (ASP.NET) WebSocket client — hubs, persistent connections and reconnect for Delphi.
SignalR Core APIASP.NET Core SignalR WebSocket client — hubs, streaming, MessagePack and JSON protocols for Delphi.
Socket.IO APISocket.IO v4 client for Delphi — engine.io transport plus rooms, namespaces and acknowledgments.
Telegram APITelegram TDLib (full client) and Bot API REST client — chat, message, file and bot endpoints for Delphi.
WhatsApp Cloud APIWhatsApp Cloud API client — Meta-hosted WhatsApp Business messaging, templates and media for Delphi.
XTB APIXTB xAPI WebSocket client — market data and trading for forex, indices, commodities and stocks.

Section index: API integrations technical documents.

Core components

The WebSocket client and server themselves, in Delphi and in .NET, together with the resilience components that guard them and the scaling components that put several servers behind one address.

Delphi and C++ Builder

WebSocket Client (Delphi)The TsgcWebSocketClient component — RFC 6455 WebSocket client for Delphi VCL, FireMonkey, Lazarus and FPC over TCP and TLS.
WebSocket Server (Delphi)TsgcWebSocketServer / TsgcWebSocketHTTPServer — Delphi WebSocket and HTTP server, RFC 6455 compliant, with TLS, virtual hosts and protocol pipelines.

.NET

WebSocket Client (.NET)The .NET port of TsgcWebSocketClient — RFC 6455 WebSocket client for .NET Framework, .NET Core, .NET 5+ and .NET Standard.
WebSocket Server (.NET)The .NET port of TsgcWebSocketHTTPServer — RFC 6455 WebSocket server with TLS and HTTP fall-back for .NET Framework, .NET Core and .NET 5+.

Resilience

API Key ManagerCentralised API-key rotation, scoping and rate-limit accounting for sgcWebSockets API and HTTP components.
Circuit BreakerCircuit-breaker resilience pattern for sgcWebSockets — automatic open/half-open/closed transitions wrap any HTTP or WebSocket call.
FirewallIP-based firewall component for sgcWebSockets servers — block, allow-list and rate-limit by address and CIDR range.
Rate LimiterPer-connection and per-key rate-limiting component — token bucket and fixed-window strategies for any sgcWebSockets server.

Scaling

Multi-node ClusteringTsgcWSCluster — scale your sgcWebSockets servers across multiple nodes. A publish or Presence event on one node reaches subscribers connected to every other node, through a zero-infrastructure mesh backplane or a Redis Pub/Sub backplane.
HTTP.sys API ServerTsgcWebSocketServer_HTTPAPI — kernel-mode (http.sys) HTTP and WebSocket server for the highest possible throughput on Windows.
Load BalancerTsgcWebSocketLoadBalancerServer — pluggable load balancer for sgcWebSockets back-ends with sticky sessions and health checks.
Proxy ServerTsgcWebSocketProxyServer — reverse-proxy for sgcWebSockets traffic with TLS termination, request rewriting and connection pooling.

Section index: Core components technical documents.

DataSnap and WebBroker

Bridges that host an existing WebBroker or DataSnap application on an sgcWebSockets server, so one executable answers REST, WebSocket and HTTP/2 on the same port.

DataSnap — HTTP.sys WebSocket + HTTP/2TsgcWSServer_HTTPAPI_WebBrokerBridge — kernel-mode (http.sys) WebBroker / DataSnap host with WebSocket and HTTP/2 transports.
DataSnap — WebBroker Bridge (WebSockets)TsgcWSHTTPWebBrokerBridgeServer — pure-Delphi WebBroker / DataSnap host with WebSocket transport on top of TsgcWebSocketHTTPServer.
DataSnap — WebBroker Bridge (WS + HTTP/2)TsgcWSHTTP2WebBrokerBridgeServer — WebBroker / DataSnap host with both WebSocket and RFC 9113 HTTP/2 transports.

Section index: DataSnap and WebBroker technical documents.

HTTP, HTTP/2 and authentication

The HTTP/2 client and server, gRPC, the OAuth2 and JWT components on both sides, WebAuthn, and the push and queue services reached over plain HTTP.

Amazon SQS ClientAmazon SQS HTTP client — send, receive, delete and manage SQS messages from Delphi with AWS Signature v4.
Apple Push Notification ServiceAPNs HTTP/2 client — send iOS and macOS push notifications from Delphi using token-based or certificate-based authentication.
Google Calendar APIGoogle Calendar v3 API client — events, calendars, ACLs and notifications with OAuth 2.0 from Delphi.
Google Cloud Pub/SubGoogle Cloud Pub/Sub REST client — publish to topics, pull from subscriptions and manage IAM bindings from Delphi.
Firebase Cloud MessagingFirebase Cloud Messaging HTTP v1 client — send Android, iOS and web push from Delphi using OAuth 2.0 service-account credentials.
gRPC ClientTsgcGRPCClient — native gRPC client over HTTP/2: unary and streaming calls, custom metadata, deadlines, compression, interceptors and automatic retry.
HTTP/2 ClientTsgcHTTP2Client — RFC 9113 HTTP/2 client over TLS with ALPN, header compression (HPACK), multiplexing and stream prioritisation.
HTTP/2 ServerTsgcWebSocketHTTPServer with HTTP/2 — RFC 9113 server-side HTTP/2 with ALPN, HPACK and server push.
JWT ClientTsgcHTTP_JWT_Client — JSON Web Token client helper for any sgcWebSockets HTTP component.
JWT ServerTsgcHTTP_JWT_Server — JSON Web Token server-side issuance and validation for sgcWebSockets HTTP and WebSocket servers.
OAuth2 ClientTsgcHTTP_OAuth2_Client — OAuth 2.0 client with authorisation-code, PKCE, client-credentials, device-code and refresh-token flows.
OAuth2 ProviderTsgcHTTP_OAuth2_Server_Provider — pre-built OAuth 2.0 provider adapters (Google, Microsoft, GitHub, etc.) for the OAuth2 client.
OAuth2 ServerTsgcHTTP_OAuth2_Server — OAuth 2.0 authorisation-server implementation for sgcWebSockets HTTP / WebSocket servers.
WebAuthn ServerTsgcWSAPIServer_WebAuthn — W3C WebAuthn Level 2 server-side relying-party for sgcWebSockets HTTP servers.

Section index: HTTP, HTTP/2 and authentication technical documents.

IoT brokers

MQTT clients preconfigured for the two managed IoT brokers, with the authentication each one insists on already wired up.

AWS IoT CoreTsgcIoTAmazon_MQTT_Client — MQTT 3.1.1 / 5.0 client tuned for AWS IoT Core with SigV4 and X.509 mutual-TLS.
Azure IoT HubTsgcIoTAzure_MQTT_Client — MQTT 3.1.1 client tuned for Azure IoT Hub with SAS-token and X.509 authentication.

Section index: IoT brokers technical documents.

Peer to peer

The NAT traversal stack: STUN, TURN and ICE as client and server, the UDP transports underneath them, and the Delphi side of RTCPeerConnection.

ICE ClientTsgcICEClient — RFC 8445 Interactive Connectivity Establishment client; combines STUN and TURN to pick the best peer-to-peer path.
RTCPeerConnectionTsgcRTCPeerConnection — Delphi-side RTCPeerConnection implementation paired with the W3C WebRTC API for browser interop.
STUN ClientTsgcSTUNClient — RFC 8489 Session Traversal Utilities for NAT client; binding requests for peer-public-address discovery.
STUN ServerTsgcSTUNServer — RFC 8489 STUN server for sgcWebSockets; lets behind-NAT peers discover their public reflexive address.
TURN ClientTsgcTURNClient — RFC 8656 Traversal Using Relays around NAT client; allocates a relayed address and relays traffic when direct paths fail.
TURN ServerTsgcTURNServer — RFC 8656 TURN relay server for sgcWebSockets; relays peer-to-peer traffic when ICE cannot establish a direct path.
UDP ClientTsgcUDPClient — low-level UDP datagram client for sgcWebSockets P2P stack; foundation for STUN, TURN and ICE.
UDP ServerTsgcUDPServer — low-level UDP datagram server for sgcWebSockets P2P stack; foundation for STUN, TURN and ICE.

Section index: Peer to peer technical documents.

Messaging protocols

WebSocket subprotocols and message brokers: MQTT, both AMQP versions, STOMP against two brokers, WAMP, WebRTC signalling, and the five custom sgc subprotocols.

AMQP 0.9.1AMQP 0.9.1 client for Delphi, C++ Builder and .NET — speak natively to RabbitMQ and other 0.9.1-compatible brokers over TCP or WebSocket.
AMQP 1.0AMQP 1.0 client for Delphi, C++ Builder and .NET — the OASIS-standardised messaging protocol used by Azure Service Bus, ActiveMQ Artemis and Apache Qpid.
Custom Protocol — DatasetsgcWebSockets custom subprotocol that streams TDataset changes over WebSocket — server publishes updates, clients apply them automatically.
Custom Protocol — End-to-End EncryptionEnd-to-end encrypted custom subprotocol — peer-to-peer keys never reach the server, perfect for sensitive payloads.
Custom Protocol — FilesFile-transfer custom subprotocol — chunked, resumable upload and download over WebSocket with progress notifications.
Custom Protocol — PresencePresence custom subprotocol — connection-state, channels and member metadata broadcast across the room, in the spirit of Pusher Channels.
Custom Protocol — sgc (Generic PubSub)sgc generic publish-subscribe custom subprotocol — channels, queued messages and broker-style fan-out built into sgcWebSockets.
MQTT ClientLightweight publish/subscribe messaging for Delphi, C++ Builder and .NET — full MQTT 3.1.1 and 5.0 support over TCP or WebSocket transports.
STOMP (ActiveMQ)STOMP 1.2 client tuned for Apache ActiveMQ — destination prefixes, JMS-style headers and broker-specific features.
STOMP (RabbitMQ)STOMP 1.2 client tuned for RabbitMQ — exchange destinations, queue conventions and RabbitMQ-specific headers.
WAMP ProtocolRouted RPC and publish-subscribe over WebSocket for Delphi, C++ Builder and .NET. WAMP v1 client and server, JSON payloads carried over the wamp WebSocket subprotocol.
WebRTC ProtocolWebRTC signalling server for browser-paired peer-to-peer audio, video and data channels — Delphi server pairs with the standard W3C WebRTC JavaScript API.

Section index: Messaging protocols technical documents.

Server APIs

Server-side components that answer a browser or platform specification rather than call somebody else’s service.

Web Push ServerTsgcWSAPIServer_WebPush — RFC 8030 Web Push server, VAPID-signed (RFC 8292) push to all major browser push services.

Section index: Server APIs technical documents.

Where to go from here

These documents sit between the product pages and the online help. Whichever of the three you need next is one link away.

Product overviewWhat sgcWebSockets is, which editions carry which components, and the supported compilers.
Feature matrixEvery feature against Standard, Professional and Enterprise, for Delphi and for .NET.
Online helpThe exhaustive per-property, per-method reference for the whole suite.
Download the TrialEvery component in these documents, with the demo projects each one names.
PricingSingle, Team and Site licences, full source code included.
Best value: All-AccessEvery eSeGeCe product, Premium Support included, from €1,059/year.
See All-Access pricing

Try sgcWebSockets

Every component described in these eighty-six documents ships in one package. Download the free Trial edition and run the quick starts against your own project.