MLLPClient Class

Properties   Methods   Events   Configuration Settings   Errors  

The MLLPClient class implements the client side of the Minimal Lower Layer Protocol.

Syntax

MLLPClient

Remarks

The MLLPClient class is used to exchange HL7 data with an MLLP server.

Connecting

To begin using the MLLPClient class, connect to an MLLP server. Connecting is simple, start by setting the SSLEnabled property to True if desired. Then either set the RemoteHost and RemotePort properties before setting the Connected property to True; or simply call the Connect method, passing it the remote host and port values directly.

When the MLLPClient first connects to the server, the Connected event fires. Additional information about the status of the connection can be accessed through the ConnectionStatus event. If the SSLEnabled property is True the SSLServerAuthentication and SSLStatus events will also fire.

Connecting Example

mllpClient.RemoteHost = "MyHostNameOrIP";
mllpClient.RemotePort = 777;
mllpClient.SSLEnabled = true;
mllpClient.Connected = true;

Sending Data

Once connected, specify the HL7 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 to send the HL7 data to the server. Once the server has received the data, it will respond with an acknowledgement, causing the class's AckIn event to fire.

Sending Data Example

mllpClient.InputData = "HL7Data";
mllpClient.Send();

Receiving Data

The MLLPClient class will automatically receive HL7 data sent from the server, and will automatically send an acknowledgement back.

When the MLLPClient 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 client 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 server.

HL7 data received by the MLLPClient 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.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ConnectedTriggers a connection or disconnection.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
InputDataThe raw HL7 data to send.
InputFilenameThe path of a file containing HL7 data to send.
KeepAliveWhen True, KEEPALIVE packets are enabled (for long connections).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the class binds.
OutputDataThe raw HL7 data received.
OutputFilenameThe path of a file in which to store received HL7 data.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe TCP port in the remote host.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLEnabledWhether TLS/SSL is enabled.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the class.
VersionThe 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.

ConfigSets or retrieves a configuration setting.
ConnectConnects to a remote host.
DisconnectDisconnects from the remote host.
DoEventsProcesses events from the internal message queue.
InterruptInterrupts the current action.
ResetReset the class.
SendSends HL7 data to the MLLP server.

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.

AckInFires immediately after receiving an acknowledgement from the server.
AckOutFires immediately before sending an acknowledgement to the server.
ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndTransferFires after incoming HL7 data finishes transferring.
ErrorInformation about errors during data delivery.
LogProvides logging information.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFires before incoming HL7 data begins transferring.
TransferFires during incoming data transfer.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

ACKCharThe positive acknowledgement character.
EndBlockCharThe character that denotes the end of HL7 data.
EOLCharThe character that denotes the end of a message block.
LogLevelThe level of detail that is logged.
NAKCharThe negative acknowledgement character.
ReceiveTimeoutMaximum number of seconds to wait after receiving a StartBlockChar.
StartBlockCharThe character that denotes the beginning of HL7 data.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 Qt Edition - Version 20.0 [Build 8203]