MLLPServer Class
Properties Methods Events Config Settings Errors
The MLLPServer class implements the server side of the Minimal Lower Layer Protocol.
Syntax
MLLPServer
Remarks
The MLLPServer class is used to exchange HL7 data with one or more connected MLLP clients.
Setting up MLLPServer to Listen for Client Connections
The first step in using the MLLPServer class is to configure it to listen for MLLP client connections. Start by setting the LocalPort property to the desired listening port. For multi-homed devices, also set the LocalHost property to the address of the network interface the MLLPServer class should listen on.
Next, optionally enable TLS/SSL with the SSLEnabled and SSLCert properties (MLLPServer supports client authentication with the SSLAuthenticateClients property).
Finally, set the Listening property to True to begin listening for client connections.
Connecting Example
mllpServer.LocalHost = "localhost";
mllpServer.LocalPort = 7777;
// The following two lines are only necessary if using TLS/SSL.
mllpServer.SSLEnabled = true;
mllpServer.SSLCert = new Certificate(CertStoreTypes.cstPFXFile, "..\\path\\to\\cert.pfx", "password", "*");
mllpServer.Listening = true;
At this point the ConnectionRequest event will fire anytime a client wishes to connect (connection requests are accepted by default), and the Connected event will fire each time a client successfully connects.
While clients are connected, the server may interact with them by using their OFTPConnectionConnectionId to interact with the class's properties.
Receiving Data
The MLLPServer class will automatically receive HL7 data sent from each client, and will automatically send acknowledgements back.
When the MLLPServer class is receiving data, immediately before data transfer begins the StartTransfer event fires. During data transfer, one or more Transfer events will fire. When data transfer is complete, the EndTransfer event fires. Any errors during data delivery will cause the Error event to fire.
Immediately before the server acknowledgement is sent the AckOut event fires. The Accept parameter of this event is used to determine the type of acknowledgement (ACK or NAK) to send back to the client.
HL7 data received by the MLLPServer class will be stored in one of the following ways:
- If an output file path has been set to the OutputFilename property, the data is written to that file.
- Otherwise, the data is stored in the OutputData property.
Sending Data
The MLLPServer class may also send data to MLLP clients. First, specify the data to send by doing one of the following:
- Set the InputFilename property to the path of a file with HL7 data.
- Set the HL7 data directly to the InputData property.
Once the data has been specified, simply call the Send method with the appropriate connection Id to send the HL7 data to the associated client. Once the client has received the data, it will respond with an acknowledgement, causing the class's AckIn event to fire.
Sending Data Example
mllpServer.Connections[connectionId].InputData = "HL7Data";
mllpServer.Send(connectionId);
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| ConnectionCount | The number of records in the arrays. |
| Connected | Triggers a connection or disconnection. |
| ConnectionId | The Id of the connection. |
| InputData | The raw HL7 data to send. |
| InputFilename | The path of a file containing HL7 data to send. |
| LocalAddress | The address of the local interface through which the connection is passing. |
| OutputData | The raw HL7 data received. |
| OutputFilename | The path of a file in which to store received HL7 data. |
| RemoteHost | The address of the MLLP client associated with the connection. |
| RemotePort | The port of the MLLP client associated with the connection. |
| Timeout | The timeout value, in seconds, for the connection. |
| DefaultTimeout | This property includes an initial timeout value to be used by incoming connections. |
| KeepAlive | When True, KEEPALIVE packets are enabled (for long connections). |
| Listening | If set to True, the class accepts incoming connections on LocalPort. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. |
| SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
| SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
| SSLCertStore | This is the name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLCertStoreType | This is the type of certificate store for this certificate. |
| SSLCertSubject | This is the subject of the certificate used for client authentication. |
| SSLEnabled | Whether TLS/SSL is enabled. |
| Version | The MLLP version to use. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Disconnect | This method disconnects the specified client. |
| DoEvents | Processes events from the internal message queue. |
| Interrupt | This method interrupts a synchronous send to the remote host. |
| Reset | Reset the class. |
| Send | Send HL7 data to the MLLP client associated with the specified connection Id. |
| Shutdown | This method shuts down the server. |
| StartListening | This method starts listening for incoming connections. |
| StopListening | This method stops listening for new connections. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| AckIn | Fires immediately after receiving an acknowledgement from a client. |
| AckOut | Fires immediately before sending an acknowledgement to a client. |
| Connected | This event is fired immediately after a connection completes (or fails). |
| ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
| Disconnected | This event is fired when a connection is closed. |
| EndTransfer | Fires after incoming HL7 data finishes transferring. |
| Error | This event fires information about errors during data delivery. |
| Log | Provides logging information. |
| SSLClientAuthentication | This event is fired when the client presents its credentials to the server. |
| SSLConnectionRequest | This event fires when a Secure Sockets Layer (SSL) connection is requested. |
| SSLStatus | This event is fired to show the progress of the secure connection. |
| StartTransfer | Fires before incoming HL7 data begins transferring. |
| Transfer | Fires during incoming data transfer. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| ACKChar | The positive acknowledgement character. |
| EndBlockChar | The character that denotes the end of HL7 data. |
| EOLChar | The character that denotes the end of a message block. |
| LogLevel | The level of detail that is logged. |
| NAKChar | The negative acknowledgement character. |
| ReceiveTimeout | Maximum number of seconds to wait after receiving a StartBlockChar. |
| StartBlockChar | The character that denotes the beginning of HL7 data. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated cipher suite. |
| SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ConnectionCount Property (MLLPServer Class)
The number of records in the arrays.
Syntax
ANSI (Cross Platform) int GetConnectionCount(); Unicode (Windows) INT GetConnectionCount();
int ipworksedi_mllpserver_getconnectioncount(void* lpObj);
int GetConnectionCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- Connected
- ConnectionId
- InputData
- InputFilename
- LocalAddress
- OutputData
- OutputFilename
- RemoteHost
- RemotePort
- SSLCertEncoded
- SSLCertStore
- SSLCertStorePassword
- SSLCertStoreType
- SSLCertSubject
- Timeout
This property is read-only and not available at design time.
Data Type
Integer
Connected Property (MLLPServer Class)
Triggers a connection or disconnection.
Syntax
ANSI (Cross Platform) int GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, int bConnected); Unicode (Windows) BOOL GetConnected(INT iConnectionId);
INT SetConnected(INT iConnectionId, BOOL bConnected);
int ipworksedi_mllpserver_getconnected(void* lpObj, int connectionid);
int ipworksedi_mllpserver_setconnected(void* lpObj, int connectionid, int bConnected);
bool GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, bool bConnected);
Default Value
FALSE
Remarks
Triggers a connection or disconnection.
This property triggers a connection or disconnection.
Setting this property to True initiates a connection attempt to the host specified by the RemoteHost property. If successful, the value of this property changes to True and the Connected event is fired.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Boolean
ConnectionId Property (MLLPServer Class)
The Id of the connection.
Syntax
ANSI (Cross Platform) char* GetConnectionId(int iConnectionId); Unicode (Windows) LPWSTR GetConnectionId(INT iConnectionId);
char* ipworksedi_mllpserver_getconnectionid(void* lpObj, int connectionid);
QString GetConnectionId(int iConnectionId);
Default Value
""
Remarks
The Id of the connection.
This property contains an identifier generated by the class that uniquely identifies the connection.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
InputData Property (MLLPServer Class)
The raw HL7 data to send.
Syntax
ANSI (Cross Platform) int GetInputData(int iConnectionId, char* &lpInputData, int &lenInputData);
int SetInputData(int iConnectionId, const char* lpInputData, int lenInputData); Unicode (Windows) INT GetInputData(INT iConnectionId, LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(INT iConnectionId, LPCSTR lpInputData, INT lenInputData);
int ipworksedi_mllpserver_getinputdata(void* lpObj, int connectionid, char** lpInputData, int* lenInputData);
int ipworksedi_mllpserver_setinputdata(void* lpObj, int connectionid, const char* lpInputData, int lenInputData);
QByteArray GetInputData(int iConnectionId);
int SetInputData(int iConnectionId, QByteArray qbaInputData);
Default Value
""
Remarks
The raw HL7 data to send.
This property is used to specify the HL7 data to send when the Send method is called.
Note that the class checks the following places for input data, in order, when Send is called. Input data is sent from the first place it is found:
- The contents of a file whose path has been set to the connection's InputFilename property.
- The data set to the connection's InputData property.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Binary String
InputFilename Property (MLLPServer Class)
The path of a file containing HL7 data to send.
Syntax
ANSI (Cross Platform) char* GetInputFilename(int iConnectionId);
int SetInputFilename(int iConnectionId, const char* lpszInputFilename); Unicode (Windows) LPWSTR GetInputFilename(INT iConnectionId);
INT SetInputFilename(INT iConnectionId, LPCWSTR lpszInputFilename);
char* ipworksedi_mllpserver_getinputfilename(void* lpObj, int connectionid);
int ipworksedi_mllpserver_setinputfilename(void* lpObj, int connectionid, const char* lpszInputFilename);
QString GetInputFilename(int iConnectionId);
int SetInputFilename(int iConnectionId, QString qsInputFilename);
Default Value
""
Remarks
The path of a file containing HL7 data to send.
This property is used to specify a path to a file whose contents will be sent when the Send method is called.
Note that the class checks the following places for input data, in order, when Send is called. Input data is sent from the first place it is found:
- The contents of a file whose path has been set to the connection's InputFilename property.
- The data set to the connection's InputData property.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
String
LocalAddress Property (MLLPServer Class)
The address of the local interface through which the connection is passing.
Syntax
ANSI (Cross Platform) char* GetLocalAddress(int iConnectionId); Unicode (Windows) LPWSTR GetLocalAddress(INT iConnectionId);
char* ipworksedi_mllpserver_getlocaladdress(void* lpObj, int connectionid);
QString GetLocalAddress(int iConnectionId);
Default Value
""
Remarks
The address of the local interface through which the connection is passing.
This property reflects the address of the local network interface through which the connection is passing. This information is typically only important for multi-homed devices.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
OutputData Property (MLLPServer Class)
The raw HL7 data received.
Syntax
ANSI (Cross Platform) int GetOutputData(int iConnectionId, char* &lpOutputData, int &lenOutputData); Unicode (Windows) INT GetOutputData(INT iConnectionId, LPSTR &lpOutputData, INT &lenOutputData);
int ipworksedi_mllpserver_getoutputdata(void* lpObj, int connectionid, char** lpOutputData, int* lenOutputData);
QByteArray GetOutputData(int iConnectionId);
Default Value
""
Remarks
The raw HL7 data received.
This property holds the raw HL7 data received from the MLLP client.
Note that the class will store output data in one of the following places, choosing the first one that is valid:
- A file whose path has been set to the connection's OutputFilename property.
- The connection's OutputData property.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is read-only and not available at design time.
Data Type
Binary String
OutputFilename Property (MLLPServer Class)
The path of a file in which to store received HL7 data.
Syntax
ANSI (Cross Platform) char* GetOutputFilename(int iConnectionId);
int SetOutputFilename(int iConnectionId, const char* lpszOutputFilename); Unicode (Windows) LPWSTR GetOutputFilename(INT iConnectionId);
INT SetOutputFilename(INT iConnectionId, LPCWSTR lpszOutputFilename);
char* ipworksedi_mllpserver_getoutputfilename(void* lpObj, int connectionid);
int ipworksedi_mllpserver_setoutputfilename(void* lpObj, int connectionid, const char* lpszOutputFilename);
QString GetOutputFilename(int iConnectionId);
int SetOutputFilename(int iConnectionId, QString qsOutputFilename);
Default Value
""
Remarks
The path of a file in which to store received HL7 data.
This property is used to specify a path to a file in which to store HL7 data received from the MLLP client.
Note that the class will store output data in one of the following places, choosing the first one that is valid:
- A file whose path has been set to the connection's OutputFilename property.
- The connection's OutputData property.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
String
RemoteHost Property (MLLPServer Class)
The address of the MLLP client associated with the connection.
Syntax
ANSI (Cross Platform) char* GetRemoteHost(int iConnectionId); Unicode (Windows) LPWSTR GetRemoteHost(INT iConnectionId);
char* ipworksedi_mllpserver_getremotehost(void* lpObj, int connectionid);
QString GetRemoteHost(int iConnectionId);
Default Value
""
Remarks
The address of the MLLP client associated with the connection.
This property reflects the address of the MLLP client associated with the connection.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
RemotePort Property (MLLPServer Class)
The port of the MLLP client associated with the connection.
Syntax
ANSI (Cross Platform) int GetRemotePort(int iConnectionId); Unicode (Windows) INT GetRemotePort(INT iConnectionId);
int ipworksedi_mllpserver_getremoteport(void* lpObj, int connectionid);
int GetRemotePort(int iConnectionId);
Default Value
0
Remarks
The port of the MLLP client associated with the connection.
This property reflects the port of the MLLP client associated with the connection.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
Timeout Property (MLLPServer Class)
The timeout value, in seconds, for the connection.
Syntax
ANSI (Cross Platform) int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout); Unicode (Windows) INT GetTimeout(INT iConnectionId);
INT SetTimeout(INT iConnectionId, INT iTimeout);
int ipworksedi_mllpserver_gettimeout(void* lpObj, int connectionid);
int ipworksedi_mllpserver_settimeout(void* lpObj, int connectionid, int iTimeout);
int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);
Default Value
0
Remarks
The timeout value, in seconds, for the connection.
This property specifies the timeout, in seconds, to use for the connection.
If set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data can't be sent immediately.
If set to a positive value, the class will automatically retry each operation that would otherwise result in a WOULDBLOCK error for a maximum of Timeout seconds.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value is 0 (asynchronous operation).
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.
This property is not available at design time.
Data Type
Integer
DefaultTimeout Property (MLLPServer Class)
This property includes an initial timeout value to be used by incoming connections.
Syntax
ANSI (Cross Platform) int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout); Unicode (Windows) INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);
int ipworksedi_mllpserver_getdefaulttimeout(void* lpObj);
int ipworksedi_mllpserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);
Default Value
0
Remarks
This property is used by the class to set the operational timeout value of all inbound connections once they are established.
By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.
Data Type
Integer
KeepAlive Property (MLLPServer Class)
When True, KEEPALIVE packets are enabled (for long connections).
Syntax
ANSI (Cross Platform) int GetKeepAlive();
int SetKeepAlive(int bKeepAlive); Unicode (Windows) BOOL GetKeepAlive();
INT SetKeepAlive(BOOL bKeepAlive);
int ipworksedi_mllpserver_getkeepalive(void* lpObj);
int ipworksedi_mllpserver_setkeepalive(void* lpObj, int bKeepAlive);
bool GetKeepAlive();
int SetKeepAlive(bool bKeepAlive);
Default Value
FALSE
Remarks
This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.
Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.
This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
Data Type
Boolean
Listening Property (MLLPServer Class)
If set to True, the class accepts incoming connections on LocalPort.
Syntax
ANSI (Cross Platform) int GetListening();
int SetListening(int bListening); Unicode (Windows) BOOL GetListening();
INT SetListening(BOOL bListening);
int ipworksedi_mllpserver_getlistening(void* lpObj);
int ipworksedi_mllpserver_setlistening(void* lpObj, int bListening);
bool GetListening();
int SetListening(bool bListening);
Default Value
FALSE
Remarks
This property indicates whether the class is listening for connections on the port specified by the LocalPort property.
Note: Use the StartListening and StopListening methods to control whether the class is listening.
This property is not available at design time.
Data Type
Boolean
LocalHost Property (MLLPServer Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksedi_mllpserver_getlocalhost(void* lpObj);
int ipworksedi_mllpserver_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (MLLPServer Class)
This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.
Syntax
ANSI (Cross Platform) int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int ipworksedi_mllpserver_getlocalport(void* lpObj);
int ipworksedi_mllpserver_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);
Default Value
0
Remarks
This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).
The service port is not shared among servers so two classs cannot be listening on the same port at the same time.
Data Type
Integer
SSLAuthenticateClients Property (MLLPServer Class)
If set to True, the server asks the client(s) for a certificate.
Syntax
ANSI (Cross Platform) int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients); Unicode (Windows) BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);
int ipworksedi_mllpserver_getsslauthenticateclients(void* lpObj);
int ipworksedi_mllpserver_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);
bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);
Default Value
FALSE
Remarks
This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.
Data Type
Boolean
SSLCertEncoded Property (MLLPServer Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworksedi_mllpserver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_mllpserver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (MLLPServer Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworksedi_mllpserver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_mllpserver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (MLLPServer Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworksedi_mllpserver_getsslcertstorepassword(void* lpObj);
int ipworksedi_mllpserver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (MLLPServer Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksedi_mllpserver_getsslcertstoretype(void* lpObj);
int ipworksedi_mllpserver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (MLLPServer Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworksedi_mllpserver_getsslcertsubject(void* lpObj);
int ipworksedi_mllpserver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLEnabled Property (MLLPServer Class)
Whether TLS/SSL is enabled.
Syntax
ANSI (Cross Platform) int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled); Unicode (Windows) BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);
int ipworksedi_mllpserver_getsslenabled(void* lpObj);
int ipworksedi_mllpserver_setsslenabled(void* lpObj, int bSSLEnabled);
bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);
Default Value
FALSE
Remarks
This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
Data Type
Boolean
Version Property (MLLPServer Class)
The MLLP version to use.
Syntax
ANSI (Cross Platform) int GetVersion();
int SetVersion(int iVersion); Unicode (Windows) INT GetVersion();
INT SetVersion(INT iVersion);
Possible Values
MV_VERSION_1(1),
MV_VERSION_2(2)
int ipworksedi_mllpserver_getversion(void* lpObj);
int ipworksedi_mllpserver_setversion(void* lpObj, int iVersion);
int GetVersion();
int SetVersion(int iVersion);
Default Value
2
Remarks
This property specifies the MLLP version the class should use. Valid values are:
- mvVersion1 (1) - MLLP Version 1
- mvVersion2 (2) - MLLP Version 2 (default)
When using MLLP version 1, there are no acknowledgements, so the AckIn and AckOut events will never fire.
This property is not available at design time.
Data Type
Integer
Config Method (MLLPServer Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksedi_mllpserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Disconnect Method (MLLPServer Class)
This method disconnects the specified client.
Syntax
ANSI (Cross Platform) int Disconnect(int iConnectionId); Unicode (Windows) INT Disconnect(INT iConnectionId);
int ipworksedi_mllpserver_disconnect(void* lpObj, int iConnectionId);
int Disconnect(int iConnectionId);
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (MLLPServer Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksedi_mllpserver_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (MLLPServer Class)
This method interrupts a synchronous send to the remote host.
Syntax
ANSI (Cross Platform) int Interrupt(int iConnectionId); Unicode (Windows) INT Interrupt(INT iConnectionId);
int ipworksedi_mllpserver_interrupt(void* lpObj, int iConnectionId);
int Interrupt(int iConnectionId);
Remarks
This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (MLLPServer Class)
Reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksedi_mllpserver_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Send Method (MLLPServer Class)
Send HL7 data to the MLLP client associated with the specified connection Id.
Syntax
ANSI (Cross Platform) int Send(int iConnectionId); Unicode (Windows) INT Send(INT iConnectionId);
int ipworksedi_mllpserver_send(void* lpObj, int iConnectionId);
int Send(int iConnectionId);
Remarks
The Send method sends data for the connection specified by ConnectionId to the associated MLLP client.
Before calling this method, specify the data to send by doing one of the following (the class will use the data from the first valid location):
- Set the InputFilename property to the path of a file with HL7 data.
- Set the HL7 data directly to the InputData property.
ConnectionId is the connected client to which the server should Send.
Once the client has received the data, it will respond with an acknowledgement, causing the class's AckIn event to fire.
Sending Data Example
mllpServer.Connections[connectionId].InputData = "HL7Data";
mllpServer.Send(connectionId);
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Shutdown Method (MLLPServer Class)
This method shuts down the server.
Syntax
ANSI (Cross Platform) int Shutdown(); Unicode (Windows) INT Shutdown();
int ipworksedi_mllpserver_shutdown(void* lpObj);
int Shutdown();
Remarks
This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StartListening Method (MLLPServer Class)
This method starts listening for incoming connections.
Syntax
ANSI (Cross Platform) int StartListening(); Unicode (Windows) INT StartListening();
int ipworksedi_mllpserver_startlistening(void* lpObj);
int StartListening();
Remarks
This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.
To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StopListening Method (MLLPServer Class)
This method stops listening for new connections.
Syntax
ANSI (Cross Platform) int StopListening(); Unicode (Windows) INT StopListening();
int ipworksedi_mllpserver_stoplistening(void* lpObj);
int StopListening();
Remarks
This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.
To stop listening and to disconnect all existing clients, call Shutdown instead.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AckIn Event (MLLPServer Class)
Fires immediately after receiving an acknowledgement from a client.
Syntax
ANSI (Cross Platform) virtual int FireAckIn(MLLPServerAckInEventParams *e);
typedef struct {
int ConnectionId;
int Accepted; int reserved; } MLLPServerAckInEventParams;
Unicode (Windows) virtual INT FireAckIn(MLLPServerAckInEventParams *e);
typedef struct {
INT ConnectionId;
BOOL Accepted; INT reserved; } MLLPServerAckInEventParams;
#define EID_MLLPSERVER_ACKIN 1 virtual INT IPWORKSEDI_CALL FireAckIn(INT &iConnectionId, BOOL &bAccepted);
class MLLPServerAckInEventParams {
public:
int ConnectionId();
bool Accepted();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void AckIn(MLLPServerAckInEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireAckIn(MLLPServerAckInEventParams *e) {...}
Remarks
This event fires immediately after receiving an acknowledgement (positive or negative) from an MLLP client.
The ConnectionId parameter reflects the Id of the connection that the acknowledgement was received on.
The Accepted parameter reflects whether the acknowledgement is positive (ACK - True) or negative (NAK - False).
Anytime a negative acknowledgement is received, the class will report an error with code 670.
AckOut Event (MLLPServer Class)
Fires immediately before sending an acknowledgement to a client.
Syntax
ANSI (Cross Platform) virtual int FireAckOut(MLLPServerAckOutEventParams *e);
typedef struct {
int ConnectionId;
int Accept; int reserved; } MLLPServerAckOutEventParams;
Unicode (Windows) virtual INT FireAckOut(MLLPServerAckOutEventParams *e);
typedef struct {
INT ConnectionId;
BOOL Accept; INT reserved; } MLLPServerAckOutEventParams;
#define EID_MLLPSERVER_ACKOUT 2 virtual INT IPWORKSEDI_CALL FireAckOut(INT &iConnectionId, BOOL &bAccept);
class MLLPServerAckOutEventParams {
public:
int ConnectionId();
bool Accept();
void SetAccept(bool bAccept);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void AckOut(MLLPServerAckOutEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireAckOut(MLLPServerAckOutEventParams *e) {...}
Remarks
This event fires immediately before the class sends an acknowledgement to an MLLP client.
ConnectionId is the Id of the connection that will receive the acknowledgement.
The Accept parameter should be set to indicate whether the class should send a positive (ACK - True) or negative (NAK - False) acknowledgement. The default is True.
Connected Event (MLLPServer Class)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(MLLPServerConnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } MLLPServerConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(MLLPServerConnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } MLLPServerConnectedEventParams;
#define EID_MLLPSERVER_CONNECTED 3 virtual INT IPWORKSEDI_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class MLLPServerConnectedEventParams {
public:
int ConnectionId();
int StatusCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Connected(MLLPServerConnectedEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireConnected(MLLPServerConnectedEventParams *e) {...}
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
ConnectionRequest Event (MLLPServer Class)
This event is fired when a request for connection comes from a remote host.
Syntax
ANSI (Cross Platform) virtual int FireConnectionRequest(MLLPServerConnectionRequestEventParams *e);
typedef struct {
const char *Address;
int Port;
int Accept; int reserved; } MLLPServerConnectionRequestEventParams;
Unicode (Windows) virtual INT FireConnectionRequest(MLLPServerConnectionRequestEventParams *e);
typedef struct {
LPCWSTR Address;
INT Port;
BOOL Accept; INT reserved; } MLLPServerConnectionRequestEventParams;
#define EID_MLLPSERVER_CONNECTIONREQUEST 4 virtual INT IPWORKSEDI_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);
class MLLPServerConnectionRequestEventParams {
public:
const QString &Address();
int Port();
bool Accept();
void SetAccept(bool bAccept);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ConnectionRequest(MLLPServerConnectionRequestEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireConnectionRequest(MLLPServerConnectionRequestEventParams *e) {...}
Remarks
This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.
Disconnected Event (MLLPServer Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(MLLPServerDisconnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } MLLPServerDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(MLLPServerDisconnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } MLLPServerDisconnectedEventParams;
#define EID_MLLPSERVER_DISCONNECTED 5 virtual INT IPWORKSEDI_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class MLLPServerDisconnectedEventParams {
public:
int ConnectionId();
int StatusCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Disconnected(MLLPServerDisconnectedEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireDisconnected(MLLPServerDisconnectedEventParams *e) {...}
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
EndTransfer Event (MLLPServer Class)
Fires after incoming HL7 data finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(MLLPServerEndTransferEventParams *e);
typedef struct {
int ConnectionId; int reserved; } MLLPServerEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(MLLPServerEndTransferEventParams *e);
typedef struct {
INT ConnectionId; INT reserved; } MLLPServerEndTransferEventParams;
#define EID_MLLPSERVER_ENDTRANSFER 6 virtual INT IPWORKSEDI_CALL FireEndTransfer(INT &iConnectionId);
class MLLPServerEndTransferEventParams {
public:
int ConnectionId();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void EndTransfer(MLLPServerEndTransferEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireEndTransfer(MLLPServerEndTransferEventParams *e) {...}
Remarks
This event fires after incoming HL7 data finishes transferring, immediately before the AckOut event is fired.
ConnectionId is the Id of the connection on which the data was received.
Error Event (MLLPServer Class)
This event fires information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(MLLPServerErrorEventParams *e);
typedef struct {
int ConnectionId;
int ErrorCode;
const char *Description; int reserved; } MLLPServerErrorEventParams;
Unicode (Windows) virtual INT FireError(MLLPServerErrorEventParams *e);
typedef struct {
INT ConnectionId;
INT ErrorCode;
LPCWSTR Description; INT reserved; } MLLPServerErrorEventParams;
#define EID_MLLPSERVER_ERROR 7 virtual INT IPWORKSEDI_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);
class MLLPServerErrorEventParams {
public:
int ConnectionId();
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(MLLPServerErrorEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireError(MLLPServerErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
ConnectionId indicates the connection for which the error is applicable.
Log Event (MLLPServer Class)
Provides logging information.
Syntax
ANSI (Cross Platform) virtual int FireLog(MLLPServerLogEventParams *e);
typedef struct {
int ConnectionId;
int LogLevel;
const char *Message;
const char *LogType; int reserved; } MLLPServerLogEventParams;
Unicode (Windows) virtual INT FireLog(MLLPServerLogEventParams *e);
typedef struct {
INT ConnectionId;
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } MLLPServerLogEventParams;
#define EID_MLLPSERVER_LOG 8 virtual INT IPWORKSEDI_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class MLLPServerLogEventParams {
public:
int ConnectionId();
int LogLevel();
const QString &Message();
const QString &LogType();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Log(MLLPServerLogEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireLog(MLLPServerLogEventParams *e) {...}
Remarks
This event fires when processing messages and provides logging information. The LogLevel configuration setting specifies the level of detail that is logged.
ConnectionId reflects the Id of the connection to which the log message pertains.
LogType specifies the type of log message. Possible values are:
- INFO
- VERBOSE
- DEBUG
LogMessage is the log message.
SSLClientAuthentication Event (MLLPServer Class)
This event is fired when the client presents its credentials to the server.
Syntax
ANSI (Cross Platform) virtual int FireSSLClientAuthentication(MLLPServerSSLClientAuthenticationEventParams *e);
typedef struct {
int ConnectionId;
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } MLLPServerSSLClientAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLClientAuthentication(MLLPServerSSLClientAuthenticationEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } MLLPServerSSLClientAuthenticationEventParams;
#define EID_MLLPSERVER_SSLCLIENTAUTHENTICATION 9 virtual INT IPWORKSEDI_CALL FireSSLClientAuthentication(INT &iConnectionId, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class MLLPServerSSLClientAuthenticationEventParams {
public:
int ConnectionId();
const QByteArray &CertEncoded();
const QString &CertSubject();
const QString &CertIssuer();
const QString &Status();
bool Accept();
void SetAccept(bool bAccept);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SSLClientAuthentication(MLLPServerSSLClientAuthenticationEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireSSLClientAuthentication(MLLPServerSSLClientAuthenticationEventParams *e) {...}
Remarks
This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").
SSLConnectionRequest Event (MLLPServer Class)
This event fires when a Secure Sockets Layer (SSL) connection is requested.
Syntax
ANSI (Cross Platform) virtual int FireSSLConnectionRequest(MLLPServerSSLConnectionRequestEventParams *e);
typedef struct {
int ConnectionId;
const char *SupportedCipherSuites;
const char *SupportedSignatureAlgs;
int CertStoreType;
char *CertStore;
char *CertPassword;
char *CertSubject; int reserved; } MLLPServerSSLConnectionRequestEventParams;
Unicode (Windows) virtual INT FireSSLConnectionRequest(MLLPServerSSLConnectionRequestEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR SupportedCipherSuites;
LPCWSTR SupportedSignatureAlgs;
INT CertStoreType;
LPWSTR CertStore;
LPWSTR CertPassword;
LPWSTR CertSubject; INT reserved; } MLLPServerSSLConnectionRequestEventParams;
#define EID_MLLPSERVER_SSLCONNECTIONREQUEST 10 virtual INT IPWORKSEDI_CALL FireSSLConnectionRequest(INT &iConnectionId, LPSTR &lpszSupportedCipherSuites, LPSTR &lpszSupportedSignatureAlgs, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);
class MLLPServerSSLConnectionRequestEventParams {
public:
int ConnectionId();
const QString &SupportedCipherSuites();
const QString &SupportedSignatureAlgs();
int CertStoreType();
void SetCertStoreType(int iCertStoreType);
const QString &CertStore();
void SetCertStore(const QString &qsCertStore);
const QString &CertPassword();
void SetCertPassword(const QString &qsCertPassword);
const QString &CertSubject();
void SetCertSubject(const QString &qsCertSubject);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SSLConnectionRequest(MLLPServerSSLConnectionRequestEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireSSLConnectionRequest(MLLPServerSSLConnectionRequestEventParams *e) {...}
Remarks
This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.
This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.
ConnectionId is the connection Id of the client requesting the connection.
SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.
SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.
CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertStore is the store name or location of the alternate certificate to use for this connection.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.
CertSubject is the subject of the alternate certificate to use for this connection.
The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
SSLStatus Event (MLLPServer Class)
This event is fired to show the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(MLLPServerSSLStatusEventParams *e);
typedef struct {
int ConnectionId;
const char *Message; int reserved; } MLLPServerSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(MLLPServerSSLStatusEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR Message; INT reserved; } MLLPServerSSLStatusEventParams;
#define EID_MLLPSERVER_SSLSTATUS 11 virtual INT IPWORKSEDI_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);
class MLLPServerSSLStatusEventParams {
public:
int ConnectionId();
const QString &Message();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void SSLStatus(MLLPServerSSLStatusEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireSSLStatus(MLLPServerSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. It is used to track the progress of the connection.
StartTransfer Event (MLLPServer Class)
Fires before incoming HL7 data begins transferring.
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(MLLPServerStartTransferEventParams *e);
typedef struct {
int ConnectionId; int reserved; } MLLPServerStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(MLLPServerStartTransferEventParams *e);
typedef struct {
INT ConnectionId; INT reserved; } MLLPServerStartTransferEventParams;
#define EID_MLLPSERVER_STARTTRANSFER 12 virtual INT IPWORKSEDI_CALL FireStartTransfer(INT &iConnectionId);
class MLLPServerStartTransferEventParams {
public:
int ConnectionId();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void StartTransfer(MLLPServerStartTransferEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireStartTransfer(MLLPServerStartTransferEventParams *e) {...}
Remarks
This event fires before incoming HL7 data begins transferring.
ConnectionId is the Id of the connection on which data is being received.
Transfer Event (MLLPServer Class)
Fires during incoming data transfer.
Syntax
ANSI (Cross Platform) virtual int FireTransfer(MLLPServerTransferEventParams *e);
typedef struct {
int ConnectionId;
int64 BytesTransferred;
const char *data; int lendata; int reserved; } MLLPServerTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(MLLPServerTransferEventParams *e);
typedef struct {
INT ConnectionId;
LONG64 BytesTransferred;
LPCSTR data; INT lendata; INT reserved; } MLLPServerTransferEventParams;
#define EID_MLLPSERVER_TRANSFER 13 virtual INT IPWORKSEDI_CALL FireTransfer(INT &iConnectionId, LONG64 &lBytesTransferred, LPSTR &lpdata, INT &lendata);
class MLLPServerTransferEventParams {
public:
int ConnectionId();
qint64 BytesTransferred();
const QByteArray &data();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Transfer(MLLPServerTransferEventParams *e);
// Or, subclass MLLPServer and override this emitter function.
virtual int FireTransfer(MLLPServerTransferEventParams *e) {...}
Remarks
This event fires one or more times while incoming data is being transferred.
The ConnectionId parameter is the Id of the connection on which data is being transferred.
The BytesTransferred parameter reflects the number of bytes transferred since the beginning of the transfer.
The Data parameter contains the portion of the data being delivered currently.
Config Settings (MLLPServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.MLLPServer Config Settings
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |
If the class considers a transmission to have timed out, it will ignore all data received until the next StartBlockChar is received.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
| 0 | IPv4 Only |
| 1 | IPv6 Only |
| 2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default) |
| TLS1.1 | 768 (Hex 300) (Default) |
| TLS1 | 192 (Hex C0) (Default) |
| SSL3 | 48 (Hex 30) [Platform Only] |
| SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown Certificate Authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown Certificate Authority revocation status. |
| 0x00000800 | Ignore unknown Root revocation status. |
| 0x00008000 | Allow test Root certificate. |
| 0x00004000 | Trust test Root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (MLLPServer Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
MLLPServer Errors
| 670 Received a negative acknowledgement. The other party received the message but could not commit the HL7 content to storage. | |
| 671 Data was invalid. A timeout occurred or the message block was improperly formatted. | |
| 672 Connection interrupted. A party disconnected while transferring data and the file stream had to be forcibly closed. |
TCPClient Errors
| 100 You cannot change the RemotePort at this time. A connection is in progress. | |
| 101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
| 102 The RemoteHost address is invalid (0.0.0.0). | |
| 104 Already connected. If you want to reconnect, close the current connection first. | |
| 106 You cannot change the LocalPort at this time. A connection is in progress. | |
| 107 You cannot change the LocalHost at this time. A connection is in progress. | |
| 112 You cannot change MaxLineLength at this time. A connection is in progress. | |
| 116 RemotePort cannot be zero. Please specify a valid service port number. | |
| 117 You cannot change the UseConnection option while the class is active. | |
| 135 Operation would block. | |
| 201 Timeout. | |
| 211 Action impossible in control's present state. | |
| 212 Action impossible while not connected. | |
| 213 Action impossible while listening. | |
| 301 Timeout. | |
| 302 Could not open file. | |
| 434 Unable to convert string to selected CodePage. | |
| 1105 Already connecting. If you want to reconnect, close the current connection first. | |
| 1117 You need to connect first. | |
| 1119 You cannot change the LocalHost at this time. A connection is in progress. | |
| 1120 Connection dropped by remote host. |
TCP/IP Errors
| 10004 [10004] Interrupted system call. | |
| 10009 [10009] Bad file number. | |
| 10013 [10013] Access denied. | |
| 10014 [10014] Bad address. | |
| 10022 [10022] Invalid argument. | |
| 10024 [10024] Too many open files. | |
| 10035 [10035] Operation would block. | |
| 10036 [10036] Operation now in progress. | |
| 10037 [10037] Operation already in progress. | |
| 10038 [10038] Socket operation on non-socket. | |
| 10039 [10039] Destination address required. | |
| 10040 [10040] Message too long. | |
| 10041 [10041] Protocol wrong type for socket. | |
| 10042 [10042] Bad protocol option. | |
| 10043 [10043] Protocol not supported. | |
| 10044 [10044] Socket type not supported. | |
| 10045 [10045] Operation not supported on socket. | |
| 10046 [10046] Protocol family not supported. | |
| 10047 [10047] Address family not supported by protocol family. | |
| 10048 [10048] Address already in use. | |
| 10049 [10049] Can't assign requested address. | |
| 10050 [10050] Network is down. | |
| 10051 [10051] Network is unreachable. | |
| 10052 [10052] Net dropped connection or reset. | |
| 10053 [10053] Software caused connection abort. | |
| 10054 [10054] Connection reset by peer. | |
| 10055 [10055] No buffer space available. | |
| 10056 [10056] Socket is already connected. | |
| 10057 [10057] Socket is not connected. | |
| 10058 [10058] Can't send after socket shutdown. | |
| 10059 [10059] Too many references, can't splice. | |
| 10060 [10060] Connection timed out. | |
| 10061 [10061] Connection refused. | |
| 10062 [10062] Too many levels of symbolic links. | |
| 10063 [10063] File name too long. | |
| 10064 [10064] Host is down. | |
| 10065 [10065] No route to host. | |
| 10066 [10066] Directory not empty | |
| 10067 [10067] Too many processes. | |
| 10068 [10068] Too many users. | |
| 10069 [10069] Disc Quota Exceeded. | |
| 10070 [10070] Stale NFS file handle. | |
| 10071 [10071] Too many levels of remote in path. | |
| 10091 [10091] Network subsystem is unavailable. | |
| 10092 [10092] WINSOCK DLL Version out of range. | |
| 10093 [10093] Winsock not loaded yet. | |
| 11001 [11001] Host not found. | |
| 11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
| 11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
| 11004 [11004] Valid name, no data record (check DNS setup). |