Struct ipworksedi::MLLPServer

Properties   Methods   Events   Config Settings   Errors  

The MLLPServer struct implements the server side of the Minimal Lower Layer Protocol.

Syntax

ipworksedi::MLLPServer

Remarks

The MLLPServer struct 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 struct is to configure it to listen for MLLP client connections. Start by setting the local_port property to the desired listening port. For multi-homed devices, also set the local_host property to the address of the network interface the MLLPServer struct should listen on.

Next, optionally enable TLS/SSL with the ssl_enabled and ssl_cert properties (MLLPServer supports client authentication with the ssl_authenticate_clients 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 on_connection_request event will fire anytime a client wishes to connect (connection requests are accepted by default), and the on_connected event will fire each time a client successfully connects.

While clients are connected, the server may interact with them by using their oftp_connection_connection_id to interact with the struct's properties.

Receiving Data

The MLLPServer struct will automatically receive HL7 data sent from each client, and will automatically send acknowledgements back.

When the MLLPServer struct is receiving data, immediately before data transfer begins the on_start_transfer event fires. During data transfer, one or more on_transfer events will fire. When data transfer is complete, the on_end_transfer event fires. Any errors during data delivery will cause the on_error event to fire.

Immediately before the server acknowledgement is sent the on_ack_out 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 struct will be stored in one of the following ways:

• If an output file path has been set to the output_file_name property, the data is written to that file.
• Otherwise, the data is stored in the output_data property.

Sending Data

The MLLPServer struct may also send data to MLLP clients. First, specify the data to send by doing one of the following:

• Set the input_file_name property to the path of a file with HL7 data.
• Set the HL7 data directly to the input_data 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 struct's on_ack_in event to fire.

Sending Data Example mllpServer.Connections[connectionId].InputData = "HL7Data"; mllpServer.Send(connectionId);

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEDI. Due to this, the MLLPServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of MLLPServer when you have finished using the instance.

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

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

connection_count property (MLLPServer Struct)

The number of records in the arrays.

Syntax

fn connection_count(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• connected
• connection_id
• input_data
• input_file_name
• local_address
• output_data
• output_file_name
• remote_host
• remote_port
• ssl_cert_effective_date
• ssl_cert_encoded
• ssl_cert_expiration_date
• ssl_cert_extended_key_usage
• ssl_cert_fingerprint
• ssl_cert_fingerprint_sha1
• ssl_cert_fingerprint_sha256
• ssl_cert_issuer
• ssl_cert_private_key
• ssl_cert_private_key_available
• ssl_cert_private_key_container
• ssl_cert_public_key
• ssl_cert_public_key_algorithm
• ssl_cert_public_key_length
• ssl_cert_serial_number
• ssl_cert_signature_algorithm
• ssl_cert_store
• ssl_cert_store_password
• ssl_cert_store_type
• ssl_cert_subject
• ssl_cert_subject_alt_names
• ssl_cert_thumbprint_md5
• ssl_cert_thumbprint_sha1
• ssl_cert_thumbprint_sha256
• ssl_cert_usage
• ssl_cert_usage_flags
• ssl_cert_version
• timeout

The array indices start at 0 and end at connection_count - 1.

This property is read-only.

Data Type

i32

connected property (MLLPServer Struct)

Triggers a connection or disconnection.

Syntax

fn connected(&self , ConnectionId : i32) -> Result<bool, IPWorksEDIError> 

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 remote_host property. If successful, the value of this property changes to True and the on_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 read-only.

Data Type

bool

connection_id property (MLLPServer Struct)

The Id of the connection.

Syntax

fn connection_id(&self , ConnectionId : i32) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

The Id of the connection.

This property contains an identifier generated by the struct 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.

Data Type

i32

input_data property (MLLPServer Struct)

The raw HL7 data to send.

Syntax

fn input_data(&self , ConnectionId : i32) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_input_data(&self, ConnectionId : i32, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_input_data_ref(&self, ConnectionId : i32, value : &[u8]) ->  Option<IPWorksEDIError> 

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 struct 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 input_file_name property.
• The data set to the connection's input_data property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

Vec

input_file_name property (MLLPServer Struct)

The path of a file containing HL7 data to send.

Syntax

fn input_file_name(&self , ConnectionId : i32) -> Result<String, IPWorksEDIError> 
fn set_input_file_name(&self, ConnectionId : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_input_file_name_ref(&self, ConnectionId : i32, value : &String) ->  Option<IPWorksEDIError> 

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 struct 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 input_file_name property.
• The data set to the connection's input_data property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

String

local_address property (MLLPServer Struct)

The address of the local interface through which the connection is passing.

Syntax

fn local_address(&self , ConnectionId : i32) -> Result<String, IPWorksEDIError> 

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.

Data Type

String

output_data property (MLLPServer Struct)

The raw HL7 data received.

Syntax

fn output_data(&self , ConnectionId : i32) -> Result<Vec<u8>, IPWorksEDIError> 

Default Value

""

Remarks

The raw HL7 data received.

This property holds the raw HL7 data received from the MLLP client.

Note that the struct 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 output_file_name property.
• The connection's output_data 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.

Data Type

Vec

output_file_name property (MLLPServer Struct)

The path of a file in which to store received HL7 data.

Syntax

fn output_file_name(&self , ConnectionId : i32) -> Result<String, IPWorksEDIError> 
fn set_output_file_name(&self, ConnectionId : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_output_file_name_ref(&self, ConnectionId : i32, value : &String) ->  Option<IPWorksEDIError> 

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 struct 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 output_file_name property.
• The connection's output_data property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

String

remote_host property (MLLPServer Struct)

The address of the MLLP client associated with the connection.

Syntax

fn remote_host(&self , ConnectionId : i32) -> Result<String, IPWorksEDIError> 

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.

Data Type

String

remote_port property (MLLPServer Struct)

The port of the MLLP client associated with the connection.

Syntax

fn remote_port(&self , ConnectionId : i32) -> Result<i32, IPWorksEDIError> 

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.

Data Type

i32

timeout property (MLLPServer Struct)

The timeout value, in seconds, for the connection.

Syntax

fn timeout(&self , ConnectionId : i32) -> Result<i32, IPWorksEDIError> 
fn set_timeout(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksEDIError> 

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 struct will automatically retry each operation that would otherwise result in a WOULDBLOCK error for a maximum of timeout seconds.

The struct will use do_events 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 struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, 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.

Data Type

i32

default_timeout property (MLLPServer Struct)

This property includes an initial timeout value to be used by incoming connections.

Syntax

fn default_timeout(&self ) -> Result<i32, IPWorksEDIError> 
fn set_default_timeout(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property is used by the struct 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

i32

keep_alive property (MLLPServer Struct)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

fn keep_alive(&self ) -> Result<bool, IPWorksEDIError> 
fn set_keep_alive(&self, value : bool) ->  Option<IPWorksEDIError> 

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

bool

listening property (MLLPServer Struct)

This property indicates whether the struct is listening for incoming connections on LocalPort.

Syntax

fn listening(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

This property indicates whether the struct is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the struct is listening.

This property is read-only.

Data Type

bool

local_host property (MLLPServer Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksEDIError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host 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 multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (MLLPServer Struct)

This property includes the Transmission Control Protocol (TCP) port in the local host where the struct listens.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksEDIError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksEDIError> 

Default Value

0

Remarks

This property must be set before the struct 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 struct is listening (i.e., after successfully assigning True to the listening property).

The service port is not shared among servers so two structs cannot be listening on the same port at the same time.

Data Type

i32

ssl_authenticate_clients property (MLLPServer Struct)

If set to True, the server asks the client(s) for a certificate.

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksEDIError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

Data Type

bool

ssl_cert_effective_date property (MLLPServer Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (MLLPServer Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (MLLPServer Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (MLLPServer Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (MLLPServer Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (MLLPServer Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (MLLPServer Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (MLLPServer Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The private_key may be available but not exportable. In this case, private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (MLLPServer Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError> 

Default Value

false

Remarks

Whether a private_key is available for the selected certificate. If private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (MLLPServer Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The name of the private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (MLLPServer Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (MLLPServer Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (MLLPServer Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (MLLPServer Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (MLLPServer Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (MLLPServer Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The store_type property denotes the type of the certificate store specified by store. If the store is password-protected, specify the password in store_password.

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:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (MLLPServer Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

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

ssl_cert_store_type property (MLLPServer Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (MLLPServer Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (MLLPServer Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (MLLPServer Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (MLLPServer Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (MLLPServer Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The text description of usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (MLLPServer Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of usage_flags is a combination of the following flags:

Please see the usage property for a text representation of usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (MLLPServer Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksEDIError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (MLLPServer Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (MLLPServer Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError> 

Default Value

""

Remarks

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.

Data Type

Vec

ssl_enabled property (MLLPServer Struct)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksEDIError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksEDIError> 

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

Data Type

bool

version property (MLLPServer Struct)

The MLLP version to use.

Syntax

fn version(&self ) -> Result<i32, IPWorksEDIError> 
fn set_version(&self, value : i32) ->  Option<IPWorksEDIError> 

Possible Values

1   // Version1
2   // Version2

Default Value

2

Remarks

This property specifies the MLLP version the struct 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 on_ack_in and on_ack_out events will never fire.

Data Type

i32

config method (MLLPServer Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEDIError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

disconnect method (MLLPServer Struct)

This method disconnects the specified client.

Syntax

fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksEDIError>

Remarks

Calling this method will disconnect the client specified by the connection_id parameter.

do_events method (MLLPServer Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksEDIError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt method (MLLPServer Struct)

This method interrupts a synchronous send to the remote host.

Syntax

fn interrupt(&self, connection_id : i32) -> Result<(), IPWorksEDIError>

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 struct. If you use send_file to upload a file, the struct will run synchronously on that Connection Id until it is completed.

reset method (MLLPServer Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksEDIError>

Remarks

This method will reset the struct's properties to their default values.

send method (MLLPServer Struct)

Send HL7 data to the MLLP client associated with the specified connection Id.

Syntax

fn send(&self, connection_id : i32) -> Result<(), IPWorksEDIError>

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 struct will use the data from the first valid location):

• Set the input_file_name property to the path of a file with HL7 data.
• Set the HL7 data directly to the input_data 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 struct's on_ack_in event to fire.

Sending Data Example mllpServer.Connections[connectionId].InputData = "HL7Data"; mllpServer.Send(connectionId);

shutdown method (MLLPServer Struct)

This method shuts down the server.

Syntax

fn shutdown(&self) -> Result<(), IPWorksEDIError>

Remarks

This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.

start_listening method (MLLPServer Struct)

This method starts listening for incoming connections.

Syntax

fn start_listening(&self) -> Result<(), IPWorksEDIError>

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

stop_listening method (MLLPServer Struct)

This method stops listening for new connections.

Syntax

fn stop_listening(&self) -> Result<(), IPWorksEDIError>

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.

on_ack_in event (MLLPServer Struct)

Fires immediately after receiving an acknowledgement from a client.

Syntax

// MLLPServerAckInEventArgs carries the MLLPServer AckIn event's parameters.
pub struct MLLPServerAckInEventArgs {
  fn connection_id(&self) -> i32
  fn accepted(&self) -> bool
}

// MLLPServerAckInEvent defines the signature of the MLLPServer AckIn event's handler function.
pub trait MLLPServerAckInEvent {
  fn on_ack_in(&self, sender : MLLPServer, e : &mut MLLPServerAckInEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_ack_in(&self) -> &'a dyn MLLPServerAckInEvent;
  pub fn set_on_ack_in(&mut self, value : &'a dyn MLLPServerAckInEvent);
  ...
}

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 struct will report an error with code 670.

on_ack_out event (MLLPServer Struct)

Fires immediately before sending an acknowledgement to a client.

Syntax

// MLLPServerAckOutEventArgs carries the MLLPServer AckOut event's parameters.
pub struct MLLPServerAckOutEventArgs {
  fn connection_id(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MLLPServerAckOutEvent defines the signature of the MLLPServer AckOut event's handler function.
pub trait MLLPServerAckOutEvent {
  fn on_ack_out(&self, sender : MLLPServer, e : &mut MLLPServerAckOutEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_ack_out(&self) -> &'a dyn MLLPServerAckOutEvent;
  pub fn set_on_ack_out(&mut self, value : &'a dyn MLLPServerAckOutEvent);
  ...
}

Remarks

This event fires immediately before the struct 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 struct should send a positive (ACK - True) or negative (NAK - False) acknowledgement. The default is True.

on_connected event (MLLPServer Struct)

This event is fired immediately after a connection completes (or fails).

Syntax

// MLLPServerConnectedEventArgs carries the MLLPServer Connected event's parameters.
pub struct MLLPServerConnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// MLLPServerConnectedEvent defines the signature of the MLLPServer Connected event's handler function.
pub trait MLLPServerConnectedEvent {
  fn on_connected(&self, sender : MLLPServer, e : &mut MLLPServerConnectedEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_connected(&self) -> &'a dyn MLLPServerConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn MLLPServerConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0, and description is "OK".

If the connection fails, status_code has the error code returned by the system. description contains a description of this code. The value of status_code is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_connection_request event (MLLPServer Struct)

This event is fired when a request for connection comes from a remote host.

Syntax

// MLLPServerConnectionRequestEventArgs carries the MLLPServer ConnectionRequest event's parameters.
pub struct MLLPServerConnectionRequestEventArgs {
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MLLPServerConnectionRequestEvent defines the signature of the MLLPServer ConnectionRequest event's handler function.
pub trait MLLPServerConnectionRequestEvent {
  fn on_connection_request(&self, sender : MLLPServer, e : &mut MLLPServerConnectionRequestEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_connection_request(&self) -> &'a dyn MLLPServerConnectionRequestEvent;
  pub fn set_on_connection_request(&mut self, value : &'a dyn MLLPServerConnectionRequestEvent);
  ...
}

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.

on_disconnected event (MLLPServer Struct)

This event is fired when a connection is closed.

Syntax

// MLLPServerDisconnectedEventArgs carries the MLLPServer Disconnected event's parameters.
pub struct MLLPServerDisconnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// MLLPServerDisconnectedEvent defines the signature of the MLLPServer Disconnected event's handler function.
pub trait MLLPServerDisconnectedEvent {
  fn on_disconnected(&self, sender : MLLPServer, e : &mut MLLPServerDisconnectedEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_disconnected(&self) -> &'a dyn MLLPServerDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn MLLPServerDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0, and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the system. description contains a description of this code. The value of status_code is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_end_transfer event (MLLPServer Struct)

Fires after incoming HL7 data finishes transferring.

Syntax

// MLLPServerEndTransferEventArgs carries the MLLPServer EndTransfer event's parameters.
pub struct MLLPServerEndTransferEventArgs {
  fn connection_id(&self) -> i32
}

// MLLPServerEndTransferEvent defines the signature of the MLLPServer EndTransfer event's handler function.
pub trait MLLPServerEndTransferEvent {
  fn on_end_transfer(&self, sender : MLLPServer, e : &mut MLLPServerEndTransferEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn MLLPServerEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn MLLPServerEndTransferEvent);
  ...
}

Remarks

This event fires after incoming HL7 data finishes transferring, immediately before the on_ack_out event is fired.

ConnectionId is the Id of the connection on which the data was received.

on_error event (MLLPServer Struct)

This event fires information about errors during data delivery.

Syntax

// MLLPServerErrorEventArgs carries the MLLPServer Error event's parameters.
pub struct MLLPServerErrorEventArgs {
  fn connection_id(&self) -> i32
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// MLLPServerErrorEvent defines the signature of the MLLPServer Error event's handler function.
pub trait MLLPServerErrorEvent {
  fn on_error(&self, sender : MLLPServer, e : &mut MLLPServerErrorEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_error(&self) -> &'a dyn MLLPServerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn MLLPServerErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally, the struct fails with an error.

error_code 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.

connection_id indicates the connection for which the error is applicable.

on_log event (MLLPServer Struct)

Provides logging information.

Syntax

// MLLPServerLogEventArgs carries the MLLPServer Log event's parameters.
pub struct MLLPServerLogEventArgs {
  fn connection_id(&self) -> i32
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// MLLPServerLogEvent defines the signature of the MLLPServer Log event's handler function.
pub trait MLLPServerLogEvent {
  fn on_log(&self, sender : MLLPServer, e : &mut MLLPServerLogEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_log(&self) -> &'a dyn MLLPServerLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn MLLPServerLogEvent);
  ...
}

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.

on_ssl_client_authentication event (MLLPServer Struct)

This event is fired when the client presents its credentials to the server.

Syntax

// MLLPServerSSLClientAuthenticationEventArgs carries the MLLPServer SSLClientAuthentication event's parameters.
pub struct MLLPServerSSLClientAuthenticationEventArgs {
  fn connection_id(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MLLPServerSSLClientAuthenticationEvent defines the signature of the MLLPServer SSLClientAuthentication event's handler function.
pub trait MLLPServerSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : MLLPServer, e : &mut MLLPServerSSLClientAuthenticationEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn MLLPServerSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn MLLPServerSSLClientAuthenticationEvent);
  ...
}

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").

on_ssl_connection_request event (MLLPServer Struct)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

// MLLPServerSSLConnectionRequestEventArgs carries the MLLPServer SSLConnectionRequest event's parameters.
pub struct MLLPServerSSLConnectionRequestEventArgs {
  fn connection_id(&self) -> i32
  fn supported_cipher_suites(&self) -> &String
  fn supported_signature_algs(&self) -> &String
  fn cert_store_type(&self) -> i32
  fn set_cert_store_type(&self, value : i32)
  fn cert_store(&self) -> &String
  fn set_cert_store(&self, value : &str)
  fn set_cert_store_ref(&self, value : &String)
  fn cert_password(&self) -> &String
  fn set_cert_password(&self, value : &str)
  fn set_cert_password_ref(&self, value : &String)
  fn cert_subject(&self) -> &String
  fn set_cert_subject(&self, value : &str)
  fn set_cert_subject_ref(&self, value : &String)
}

// MLLPServerSSLConnectionRequestEvent defines the signature of the MLLPServer SSLConnectionRequest event's handler function.
pub trait MLLPServerSSLConnectionRequestEvent {
  fn on_ssl_connection_request(&self, sender : MLLPServer, e : &mut MLLPServerSSLConnectionRequestEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_ssl_connection_request(&self) -> &'a dyn MLLPServerSSLConnectionRequestEvent;
  pub fn set_on_ssl_connection_request(&mut self, value : &'a dyn MLLPServerSSLConnectionRequestEvent);
  ...
}

Remarks

This event fires when an SSL connection is requested and ssl_provider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when ssl_provider is set to Platform.

This event allows the struct to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

connection_id is the connection Id of the client requesting the connection.

supported_cipher_suites is a comma-separated list of cipher suites that the client supports.

supported_signature_algs is a comma-separated list of certificate signature algorithms that the client supports.

cert_store_type is the store type of the alternate certificate to use for this connection. The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

cert_store 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:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

cert_password is the password of the certificate store containing the alternate certificate to use for this connection.

cert_subject 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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

on_ssl_status event (MLLPServer Struct)

This event is fired to show the progress of the secure connection.

Syntax

// MLLPServerSSLStatusEventArgs carries the MLLPServer SSLStatus event's parameters.
pub struct MLLPServerSSLStatusEventArgs {
  fn connection_id(&self) -> i32
  fn message(&self) -> &String
}

// MLLPServerSSLStatusEvent defines the signature of the MLLPServer SSLStatus event's handler function.
pub trait MLLPServerSSLStatusEvent {
  fn on_ssl_status(&self, sender : MLLPServer, e : &mut MLLPServerSSLStatusEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn MLLPServerSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn MLLPServerSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

on_start_transfer event (MLLPServer Struct)

Fires before incoming HL7 data begins transferring.

Syntax

// MLLPServerStartTransferEventArgs carries the MLLPServer StartTransfer event's parameters.
pub struct MLLPServerStartTransferEventArgs {
  fn connection_id(&self) -> i32
}

// MLLPServerStartTransferEvent defines the signature of the MLLPServer StartTransfer event's handler function.
pub trait MLLPServerStartTransferEvent {
  fn on_start_transfer(&self, sender : MLLPServer, e : &mut MLLPServerStartTransferEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn MLLPServerStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn MLLPServerStartTransferEvent);
  ...
}

Remarks

This event fires before incoming HL7 data begins transferring.

ConnectionId is the Id of the connection on which data is being received.

on_transfer event (MLLPServer Struct)

Fires during incoming data transfer.

Syntax

// MLLPServerTransferEventArgs carries the MLLPServer Transfer event's parameters.
pub struct MLLPServerTransferEventArgs {
  fn connection_id(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn data(&self) -> &[u8]
}

// MLLPServerTransferEvent defines the signature of the MLLPServer Transfer event's handler function.
pub trait MLLPServerTransferEvent {
  fn on_transfer(&self, sender : MLLPServer, e : &mut MLLPServerTransferEventArgs);
}

impl <'a> MLLPServer<'a> {
  pub fn on_transfer(&self) -> &'a dyn MLLPServerTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn MLLPServerTransferEvent);
  ...
}

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 Struct)

MLLPServer Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (MLLPServer Struct)

MLLPServer Errors

TCPClient Errors

TCP/IP Errors