imtcom::CServerConnectionInterfaceParam

Basic implementation of IServerConnectionInterface with protocol-port mapping. More...

#include <CServerConnectionInterfaceParam.h>

Inheritance diagram for imtcom::CServerConnectionInterfaceParam:

Public Member Functions
	CServerConnectionInterfaceParam ()
	Default constructor.
void	RegisterProtocol (ProtocolType protocol)
	Register a protocol as supported.

Additional Inherited Members
Public Types inherited from imtcom::IServerConnectionInterface
enum	ProtocolType {   PT_UNKNOWN , PT_HTTP , PT_WEBSOCKET , PT_FILE ,   PT_GRPC }
	Communication protocols supported by server connections. More...
enum	ConnectionFlags { CF_DEFAULT = 0x1 , CF_SECURE = 0x2 }
	Flags controlling connection security and behavior. More...
typedef QList< ProtocolType >	ProtocolTypes
	List of protocol types for querying supported protocols.

Detailed Description

Basic implementation of IServerConnectionInterface with protocol-port mapping.

CServerConnectionInterfaceParam provides the core data storage and logic for server connection configuration. It maintains a map of protocols to port numbers and implements all methods defined by IServerConnectionInterface.

This class serves as the base for CServerConnectionInterfaceParamComp and can be used directly in non-ACF contexts where component infrastructure is not needed.

Key Features

Protocol Registration:

• Dynamic protocol registration via RegisterProtocol()
• Supports any protocol type from IServerConnectionInterface::ProtocolType
• GetSupportedProtocols() returns only registered protocols

Port Mapping:

• Independent port configuration per protocol
• Map-based storage (QMap<ProtocolType, int>)
• Zero port value indicates unset/disabled protocol

URL Generation:

• Automatic scheme selection (http/https, ws/wss) based on CF_SECURE flag
• Handles standard and custom ports
• Proper URL encoding and formatting

Serialization:

• Implements ISerializable for configuration persistence
• Serializes host, ports, and connection flags
• Compatible with ACF serialization framework

Change Management:

• Implements IChangeable for observable modifications
• Supports copy, clone, reset, and equality operations
• Change notifications when properties modified

Usage Example

// Create instance
CServerConnectionInterfaceParam connection;
 
// Register protocols
connection.RegisterProtocol(IServerConnectionInterface::PT_HTTP);
connection.RegisterProtocol(IServerConnectionInterface::PT_WEBSOCKET);
 
// Configure connection
connection.SetHost("api.example.com");
connection.SetPort(IServerConnectionInterface::PT_HTTP, 8080);
connection.SetPort(IServerConnectionInterface::PT_WEBSOCKET, 8081);
connection.SetConnectionFlags(IServerConnectionInterface::CF_SECURE);
 
// Generate URLs
QUrl httpUrl, wsUrl;
connection.GetUrl(IServerConnectionInterface::PT_HTTP, httpUrl);
// httpUrl = "https://api.example.com:8080"
 
connection.GetUrl(IServerConnectionInterface::PT_WEBSOCKET, wsUrl);
// wsUrl = "wss://api.example.com:8081"
 
// Check supported protocols
auto protocols = connection.GetSupportedProtocols();
qDebug() << "Supports" << protocols.size() << "protocols";

Serialization Format

The class serializes the following data:

• Connection flags (int): CF_DEFAULT or CF_SECURE
• Host name (QString): DNS name, IP address, or file path
• Port map (map of ProtocolType → int): Protocol-specific ports

Thread Safety

This class is not thread-safe. If accessed from multiple threads, external synchronization is required. Consider using CServerConnectionInterfaceParamComp which may provide additional thread safety through component framework.

See also

IServerConnectionInterface, CServerConnectionInterfaceParamComp

Definition at line 101 of file CServerConnectionInterfaceParam.h.

Constructor & Destructor Documentation

CServerConnectionInterfaceParam()

imtcom::CServerConnectionInterfaceParam::CServerConnectionInterfaceParam

(

)

Default constructor.

Initializes the connection parameter with:

• Connection flags: CF_DEFAULT (insecure)
• Host: empty string
• Port map: empty (no protocols registered)

Member Function Documentation

RegisterProtocol()

void imtcom::CServerConnectionInterfaceParam::RegisterProtocol

(

ProtocolType

protocol

)

Register a protocol as supported.

Adds the specified protocol to the list of supported protocols. Once registered, the protocol can be configured with SetPort() and queried with GetPort() and GetUrl().

Registering a protocol does not set a port - you must call SetPort() separately to configure the port number.

Parameters

protocol

Protocol type to register.

See also

GetSupportedProtocols(), SetPort()

Example:

CServerConnectionInterfaceParam connection;
 
// Register protocols you want to support
connection.RegisterProtocol(IServerConnectionInterface::PT_HTTP);
connection.RegisterProtocol(IServerConnectionInterface::PT_GRPC);
 
// Now configure ports
connection.SetPort(IServerConnectionInterface::PT_HTTP, 8080);
connection.SetPort(IServerConnectionInterface::PT_GRPC, 50051);