ESEGECE sgcWebSockets Enterprise v2023.4.0 Full Source
ESEGECE sgcWebSockets Enterprise v2023.4.0 Full Source
sgcWebSockets is a complete package providing access to WebSockets protocol, allowing to create WebSockets Servers, Intraweb Clients or WebSocket Clients in VCL, Lazarus/FPC and Firemonkey applications. WebSocket is a computer communications protocol, providing full-duplex communication channels over a single TCP connection. The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011. WebSocket is designed to be implemented in web browsers and web servers, but it can be used by any client or server application. The WebSocket protocol makes possible more interaction between a browser and a web site, facilitating live content and the creation of real-time game.
Fully functional multithreaded WebSocket server according to RFC 6455.
Supports Firemonkey (Windows, MacOS, iOS and Android).
Supports Linux 64.
Supports Lazarus / FreePascal.
Supports CBuilder.
Supports C# .NET through sgcWebSockets.dll
Supports Chrome, Firefox, Safari, Opera and Internet Explorer (including iPhone, iPad and iPod)
Binary and Full Unicode Messages Support
Message compression using PerMessage_Deflate extension.
Flash FallBack for Web Browsers without native WebSockets (like Internet Explorer 6-9).
Multiple Threads Support
Server component providing WebSocket and HTTP connections through the same port.
Client WebSocket supports connections through Socket.IO Servers.
Client WebSocket supports connections through HTTP Proxy Servers.
WatchDog and HeartBeat built-in support.
Events Available: OnConnect, OnDisconnect, onmessage, onerror
Built-in sub-protocols: JSON-RPC 2.0(Transactional Messages, PubSub, RPC, Queues, QoS and more), MQTT, Datasets, Binary Files, WebRTC and WAMP.
Built-in jР°vascript libraries to support browser clients.
Easy to setup
jР°vascript Events for a full control
Async Events using Ajax
SSL/TLS support on Server and Client components
MORE ABOUT OUR VALUE
Custom Objects
Every time a new WebSocket connection is established, sgcWebSockets creates a TsgcWSConnection class where you can access to some properties like identifier, bytes received/sent, client IP... and there is a property called Data where you can store objects in memory like database access, session objects...
Basic
implements Basic Access Authentication, only applies to VCL Websockets (Server and Client) and HTTP Requests (client webbrowsers don't implement this type of authentication). When a client tries to connect, it sends a header using AUTH BASIC specification.
Secure Connections
SSL support is based on Indy implementation, so you need to deploy openssl libraries in order to use this feature. In Compiled Demos file, there is a directory called Third-Parties/ openssl, where you can find the libraries need for every Delphi Version.
Compression
This is a feature that works very well when you need to send a lot of data, usually using a binary message, because it compresses WebSocket message using protocol "PerMessage_Deflate" which is supported by some browsers like Chrome.
Bindings
Usually Server have more than one IP, if you enable a WebSocket Server and set listening port to 80, when server starts, tries to listen port 80 of ALL IP, so if you have 3 IP, it will block port 80 of each IP's.
Bindings allows to define which exact IP and Port are used by the Server. Example, if you need to listen on port 80 for IP 127.0.0.1 (internal address) and 80.254.21.11 (public address).
Quality of Service (QoS)
SGC Default Protocol implements a QoS (Quality of Service) for message delivery, there are 3 different types:
Level 0: "At most once"
where messages are delivered according to the best efforts of the underlying TCP/IP network. Message loss or duplication can occur. This level could be used, for example, with ambient sensor data where it does not matter if an individual reading is lost as the next one will be published soon after.
Level 1: "At least once"
where messages are assured to arrive but duplicates may occur.
Level 2: "Exactly once"
where message are assured to arrive exactly once. This level could be used, for example, with billing systems where duplicate or lost messages could lead to incorrect charges being applied.
Queues
SGC Default Protocol implements Queues to add persistence to published messages (it's only available for Published messages)
Level 0
Messages are not queued on Server
Level 1
only last message is queued on Server, and is sent every time a client subscribes to a new channel or connects to server.
Level 2
All messages are queued on Server, and are sent every time a client subscribes to a new channel or connects to server.
Transactions
sgcWebSockets SGC Protocol supports transactional messaging, when a client commits a transaction, all messages sent by client are processed on server side. There are 3 methods called by client
StartTransaction
Creates a New Transaction on server side and all messages that are sent from client to server after this method, are queued on Server side, until client calls to Commit or Rollback
Commit
When a client calls to commit, all messages queued by server are processed.
RollBack
When a client calls to RollBack, all messages queued by server are deleted and not processed on server side.
HTTP
TsgcWebSocketHTTPServer is a component that allows to handle WebSocket and HTTP connections using the SAME port. Is very useful when you need to setup a server where only HTTP port is enabled (usually 80 port). This component supports all TsgcWeBSocketServer features and allows to serve HTML pages.
You can serve HTML pages statically, using DocumentRoot property, example: if you save test.html in directory "C:\inetpub\wwwroot", and you set DocumentRoot to "C:\inetpub\wwwroot". If a client tries to access to test.html, it will be served automatically, example:
http://localhost/test.html
Or you can serve HTML or other resources dynamically by code, to do this, there is an event called OnCommandGet that is fired every time a client requests a new HTML page, image, jР°vascript file...
Throttle
Bandwidth Throttling is supported by Server and Client components, if enabled, can limit the amount of bits per second sent/received by socket. Indy uses a blocking method, so if a client is limiting its reading, unread data will be inside client socket and server will be blocked from writing new data to client. As much slower is client reading data, much slower is server writing new data.
Server-Sent Events
SSE are not part of WebSockets, defines an API for opening an HTTP connection for receiving push notifications from a server.
SSEs are sent over traditional HTTP. That means they do not require a special protocol or server implementation to get working. In addition, Server-Sent Events have a variety of features that WebSockets lack by design such as automatic reconnection, event IDs, and the ability to send arbitrary events.
HeartBeat
On Server components, automatically sends a ping to all active WebSocket connections every x seconds.
On Client components, automatically sends a ping to server every x seconds.
WatchDog
On Server components, automatically restart server after unexpected disconnection.
On Client components, automatically reconnect to server after unexpected disconnection.
Proxy
Client WebSocket components support WebSocket connections through proxies
LoadBalancing
Load Balancing allows to distribute work between several back-end servers, every time a new client request a connection, it connects to a load balancer server (which is connected to back-end servers) and returns a connection string with information about host, port... which is used by client to connect to a server. If you have for example 4 servers, with this method all servers will have, more or less, the same number of connections, and work load will be similar.
If a client want to send a message to all clients of all servers, just use broadcast method, and this message will be broadcast to all servers connected to Load Balancer Server.
FallBack
Web Browsers without WebSockets support, can use Flash to connect to WebSocket Server (example: Internet Explorer from version 6 to 9).
If Flash is not enabled, then tries to connect using Server-Sent Events + XHR.
2023.4.0: 2023
[+] : New Server API Component TsgcWSAPIServer_WebPush, implements WebPush Protocol on Server Side, allowing to ask permission to the users, register the subscriptions, send notifications and more.
[+] : New Client API Component TsgcWebPush_Client, implements WebPush Protocol on Client Side, allowing to send notifications to users via desktop and mobile web.
[+] : New Demo showing the main features of WebPush Protocol, the sample can be found in the folder "20.HTTP_Protocol\11.WebPush_Notifications".
[+] : Improved SignalRCore Client, new property SignalRCore.Authentication.TokenParam which allows to configure where pass the access_token, as a query parameter or as a header.
[+] : Improved OpenAPI Parser, added support for AdditionalProperties.
[+] : Improved OAuth2 Server, there is a new event "OnOAuth2Unauthorized" which is called when a request is not authorized and will be disconnected here you can configure which endpoints require OAuth2 Authentication and which not.
[+] : Improved JWT Server, there is a new event "OnJWTUnauthorized" which is called when a request is not authorized and will be disconnected, here you can configure which endpoints require JWT Authentication and which not.
: Fixed Bug TsgcWebSocketServer, if a connection is closed with an error 10053 while is writing data, the thread freezes trying to closing the socket again.
: Fixed Bug TsgcWebSocketServer, if server receives an OPTIONS request while the Basic Authentication is enabled, the Server must not return a realm. Now the request is handled in the OnCommandOther event.
: Fixed Bug AMQP Protocol, if there was an exception inside the event OnAMQPBasicDeliver, the connection was closed.
: Fixed Bug OpenAPI Parser, deleted private/public sections not required.
: Fixed Bug RTCPeerConnection, EIntOverflow when converting an array of bytes to UInt64.
: Fixed Bug OpenAPI Parser fails to register the license if the installer were not used previously.
: Fixed Bug OpenAPI Client, the Objects and Property arrays were not destroyed. (Thanks to Waldemar for the fix).
[+] : New Server API Component TsgcWSAPIServer_WebPush, implements WebPush Protocol on Server Side, allowing to ask permission to the users, register the subscriptions, send notifications and more.
[+] : New Client API Component TsgcWebPush_Client, implements WebPush Protocol on Client Side, allowing to send notifications to users via desktop and mobile web.
[+] : New Demo showing the main features of WebPush Protocol, the sample can be found in the folder "20.HTTP_Protocol\11.WebPush_Notifications".
[+] : Improved SignalRCore Client, new property SignalRCore.Authentication.TokenParam which allows to configure where pass the access_token, as a query parameter or as a header.
[+] : Improved OpenAPI Parser, added support for AdditionalProperties.
[+] : Improved OAuth2 Server, there is a new event "OnOAuth2Unauthorized" which is called when a request is not authorized and will be disconnected here you can configure which endpoints require OAuth2 Authentication and which not.
[+] : Improved JWT Server, there is a new event "OnJWTUnauthorized" which is called when a request is not authorized and will be disconnected, here you can configure which endpoints require JWT Authentication and which not.
Only for V.I.P
Warning! You are not allowed to view this text.