Unit Olf.Net.Socket.Messaging

Functions and Procedures
Constants
Variables

Description

***************************************************************************

Socket Messaging Library

Copyright 2023-2024 Patrick Prémartin under AGPL 3.0 license.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

***************************************************************************

Socket Messaging is a Delphi Library for managing a messaging system over TCP/IP sockets between clients and servers or peer to peer programs.

The library can be used in any Delphi project on recent versions of the environment. It uses the TSocket class from System.Net.Socket, threads and generic collections.

To use this library more simply, and obtain the source code you need to use a client and server in your project, with your own interface, without coding, use this code generator : https://smcodegenerator.olfsoftware.fr/

***************************************************************************

Author(s) : Patrick PREMARTIN

Site : https://socketmessaging.developpeur-pascal.fr/

Project site : https://github.com/DeveloppeurPascal/Socket-Messaging-Library

*************************************************************************** File last update : 28/05/2024 12:19:19 Signature : 8bc0536e5b81b097a02934e6b9ce4a388f5c9ff9 ***************************************************************************

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class TOlfSMException  
Class TOlfSMMessage  
Interface IOlfSMMessagesRegister  
Class TOlfSMServer  
Class TOlfSMSrvConnectedClient  
Class TOlfSMSrvConnectedClientsList  
Class TOlfSMClient  

Types

TOlfSMMessageID = byte;
TOlfSMMessageSize = int64;
TOlfSMMessagesDict = TObjectDictionary<TOlfSMMessageID, TOlfSMMessage>;
TOlfSMReceivedMessageEvent = procedure(Const ASender : TOlfSMSrvConnectedClient; Const AMessage: TOlfSMMessage) of object;
TOlfSMReceivedMessageEvent = procedure (Const ASender: TOlfSMSrvConnectedClient; Const AMessage: T) of object;
TOlfMessageSubscribers = TList<TOlfSMReceivedMessageEvent>;
TOlfSubscribers = TObjectDictionary<TOlfSMMessageID, TOlfMessageSubscribers>;
TOlfSMServerEvent = procedure(AServer: TOlfSMServer) of object;
TOlfSMEncodeDecodeMessageEvent = function(AFrom: TStream): TStream of object;
TOlfSMConnectedClientProc = reference to procedure(Const AConnectedClient : TOlfSMSrvConnectedClient);
TOlfSMConnectedClientEvent = procedure(Const AConnectedClient : TOlfSMSrvConnectedClient) of object;
TOlfMessageID = TOlfSMMessageID;
TOlfMessageSize = TOlfSMMessageSize;
TOlfSocketMessagingServerConnectedClient = TOlfSMSrvConnectedClient;
TOlfSocketMessagingException = TOlfSMException;
TOlfSocketMessagingServer = TOlfSMServer;
TOlfSocketMessagingClient = TOlfSMClient;
TOlfSocketMessage = TOlfSMMessage;
TOlfSocketMessagesDict = TOlfSMMessagesDict;
IOlfSocketMessagesRegister = IOlfSMMessagesRegister;
TOlfReceivedMessageEvent = TOlfSMReceivedMessageEvent;

Description

Types

TOlfSMMessageID = byte;
 
TOlfSMMessageSize = int64;

256 messages (0..255)

TOlfSMMessagesDict = TObjectDictionary<TOlfSMMessageID, TOlfSMMessage>;
 
TOlfSMReceivedMessageEvent = procedure(Const ASender : TOlfSMSrvConnectedClient; Const AMessage: TOlfSMMessage) of object;
 
TOlfSMReceivedMessageEvent = procedure (Const ASender: TOlfSMSrvConnectedClient; Const AMessage: T) of object;
 
TOlfMessageSubscribers = TList<TOlfSMReceivedMessageEvent>;
 
TOlfSubscribers = TObjectDictionary<TOlfSMMessageID, TOlfMessageSubscribers>;
 
TOlfSMServerEvent = procedure(AServer: TOlfSMServer) of object;
 
TOlfSMEncodeDecodeMessageEvent = function(AFrom: TStream): TStream of object;
 
TOlfSMConnectedClientProc = reference to procedure(Const AConnectedClient : TOlfSMSrvConnectedClient);
 
TOlfSMConnectedClientEvent = procedure(Const AConnectedClient : TOlfSMSrvConnectedClient) of object;
 
TOlfMessageID = TOlfSMMessageID;

************************************************** * For compatibility with existing code * Don't use this types in a new project. ************************************************** <summary> DEPRECATED : use TOlfSMMessageID </summary>

TOlfMessageSize = TOlfSMMessageSize;

DEPRECATED : use TOlfSMMessageSize

TOlfSocketMessagingServerConnectedClient = TOlfSMSrvConnectedClient;

DEPRECATED : use TOlfSMSrvConnectedClient

TOlfSocketMessagingException = TOlfSMException;

DEPRECATED : use TOlfSMException

TOlfSocketMessagingServer = TOlfSMServer;

DEPRECATED : use TOlfSMServer

TOlfSocketMessagingClient = TOlfSMClient;

DEPRECATED : use TOlfSMClient

TOlfSocketMessage = TOlfSMMessage;

DEPRECATED : use TOlfSMMessage

TOlfSocketMessagesDict = TOlfSMMessagesDict;

DEPRECATED : use TOlfSMMessagesDict

IOlfSocketMessagesRegister = IOlfSMMessagesRegister;

DEPRECATED : use IOlfSMMessagesRegister

TOlfReceivedMessageEvent = TOlfSMReceivedMessageEvent;

DEPRECATED : use TOlfSMReceivedMessageEvent

Socket Messaging Library (c) 2023-2025 Patrick PREMARTIN - Powered by PasDoc
Generated by PasDoc 0.16.0.