MLLPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_MLLPServer

Procedural Interface

 ipworksedi_mllpserver_open();
 ipworksedi_mllpserver_close($res);
 ipworksedi_mllpserver_register_callback($res, $id, $function);
 ipworksedi_mllpserver_get_last_error($res);
 ipworksedi_mllpserver_get_last_error_code($res);
 ipworksedi_mllpserver_set($res, $id, $index, $value);
 ipworksedi_mllpserver_get($res, $id, $index);
 ipworksedi_mllpserver_do_config($res, $configurationstring);
 ipworksedi_mllpserver_do_disconnect($res, $connectionid);
 ipworksedi_mllpserver_do_doevents($res);
 ipworksedi_mllpserver_do_interrupt($res, $connectionid);
 ipworksedi_mllpserver_do_reset($res);
 ipworksedi_mllpserver_do_send($res, $connectionid);
 ipworksedi_mllpserver_do_shutdown($res);
 ipworksedi_mllpserver_do_startlistening($res);
 ipworksedi_mllpserver_do_stoplistening($res);

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.

Method List

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

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.

Config Settings

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

ConnectionCount Property (IPWorksEDI_MLLPServer Class)

The number of records in the arrays.

Object Oriented Interface

public function getConnectionCount();

Procedural Interface

ipworksedi_mllpserver_get($res, 1 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• Connected
• ConnectionId
• InputData
• InputFileName
• LocalAddress
• OutputData
• OutputFileName
• RemoteHost
• RemotePort
• SSLCertEffectiveDate
• SSLCertEncoded
• SSLCertExpirationDate
• SSLCertExtendedKeyUsage
• SSLCertFingerprint
• SSLCertFingerprintSHA1
• SSLCertFingerprintSHA256
• SSLCertIssuer
• SSLCertPrivateKey
• SSLCertPrivateKeyAvailable
• SSLCertPrivateKeyContainer
• SSLCertPublicKey
• SSLCertPublicKeyAlgorithm
• SSLCertPublicKeyLength
• SSLCertSerialNumber
• SSLCertSignatureAlgorithm
• SSLCertStore
• SSLCertStorePassword
• SSLCertStoreType
• SSLCertSubject
• SSLCertSubjectAltNames
• SSLCertThumbprintMD5
• SSLCertThumbprintSHA1
• SSLCertThumbprintSHA256
• SSLCertUsage
• SSLCertUsageFlags
• SSLCertVersion
• Timeout

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

This property is read-only and not available at design time.

Data Type

Integer

Connected Property (IPWorksEDI_MLLPServer Class)

Triggers a connection or disconnection.

Object Oriented Interface

public function getConnected($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 2 , $connectionid);

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 read-only and not available at design time.

Data Type

Boolean

ConnectionId Property (IPWorksEDI_MLLPServer Class)

The Id of the connection.

Object Oriented Interface

public function getConnectionId($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 3 , $connectionid);

Default Value

0

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

Integer

InputData Property (IPWorksEDI_MLLPServer Class)

The raw HL7 data to send.

Object Oriented Interface

public function getInputData($connectionid);
public function setInputData($connectionid, $value);

Procedural Interface

ipworksedi_mllpserver_get($res, 4 , $connectionid);
ipworksedi_mllpserver_set($res, 4, $value , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

The path of a file containing HL7 data to send.

Object Oriented Interface

public function getInputFileName($connectionid);
public function setInputFileName($connectionid, $value);

Procedural Interface

ipworksedi_mllpserver_get($res, 5 , $connectionid);
ipworksedi_mllpserver_set($res, 5, $value , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getLocalAddress($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 6 , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

The raw HL7 data received.

Object Oriented Interface

public function getOutputData($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 7 , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getOutputFileName($connectionid);
public function setOutputFileName($connectionid, $value);

Procedural Interface

ipworksedi_mllpserver_get($res, 8 , $connectionid);
ipworksedi_mllpserver_set($res, 8, $value , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

The address of the MLLP client associated with the connection.

Object Oriented Interface

public function getRemoteHost($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 9 , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

The port of the MLLP client associated with the connection.

Object Oriented Interface

public function getRemotePort($connectionid);

Procedural Interface

ipworksedi_mllpserver_get($res, 10 , $connectionid);

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 (IPWorksEDI_MLLPServer Class)

The timeout value, in seconds, for the connection.

Object Oriented Interface

public function getTimeout($connectionid);
public function setTimeout($connectionid, $value);

Procedural Interface

ipworksedi_mllpserver_get($res, 11 , $connectionid);
ipworksedi_mllpserver_set($res, 11, $value , $connectionid);

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.

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.

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getDefaultTimeout();
public function setDefaultTimeout($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 12 );
ipworksedi_mllpserver_set($res, 12, $value );

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getKeepAlive();
public function setKeepAlive($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 13 );
ipworksedi_mllpserver_set($res, 13, $value );

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksedi_mllpserver_get($res, 14 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

This property is read-only and not available at design time.

Data Type

Boolean

LocalHost Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 15 );
ipworksedi_mllpserver_set($res, 15, $value );

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 class initiate connections (or accept in the case of server classs) 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 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 multihomed 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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 16 );
ipworksedi_mllpserver_set($res, 16, $value );

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 17 );
ipworksedi_mllpserver_set($res, 17, $value );

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

SSLCertEffectiveDate Property (IPWorksEDI_MLLPServer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_mllpserver_get($res, 18 );

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

SSLCertExpirationDate Property (IPWorksEDI_MLLPServer Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_mllpserver_get($res, 19 );

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

SSLCertExtendedKeyUsage Property (IPWorksEDI_MLLPServer Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_mllpserver_get($res, 20 );

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

SSLCertFingerprint Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_mllpserver_get($res, 21 );

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

SSLCertFingerprintSHA1 Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_mllpserver_get($res, 22 );

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

SSLCertFingerprintSHA256 Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_mllpserver_get($res, 23 );

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

SSLCertIssuer Property (IPWorksEDI_MLLPServer Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_mllpserver_get($res, 24 );

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

SSLCertPrivateKey Property (IPWorksEDI_MLLPServer Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_mllpserver_get($res, 25 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksEDI_MLLPServer Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_mllpserver_get($res, 26 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_mllpserver_get($res, 27 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksEDI_MLLPServer Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_mllpserver_get($res, 28 );

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

SSLCertPublicKeyAlgorithm Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_mllpserver_get($res, 29 );

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

SSLCertPublicKeyLength Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_mllpserver_get($res, 30 );

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

Integer

SSLCertSerialNumber Property (IPWorksEDI_MLLPServer Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_mllpserver_get($res, 31 );

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

SSLCertSignatureAlgorithm Property (IPWorksEDI_MLLPServer Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_mllpserver_get($res, 32 );

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

SSLCertStore Property (IPWorksEDI_MLLPServer Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 33 );
ipworksedi_mllpserver_set($res, 33, $value );

Default Value

'MY'

Remarks

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:

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

Binary String

SSLCertStorePassword Property (IPWorksEDI_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.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 34 );
ipworksedi_mllpserver_set($res, 34, $value );

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 (IPWorksEDI_MLLPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 35 );
ipworksedi_mllpserver_set($res, 35, $value );

Default Value

0

Remarks

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:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_mllpserver_get($res, 36 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_MLLPServer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_mllpserver_get($res, 37 );

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

SSLCertThumbprintSHA1 Property (IPWorksEDI_MLLPServer Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_mllpserver_get($res, 38 );

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

SSLCertThumbprintSHA256 Property (IPWorksEDI_MLLPServer Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_mllpserver_get($res, 39 );

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

SSLCertUsage Property (IPWorksEDI_MLLPServer Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_mllpserver_get($res, 40 );

Default Value

''

Remarks

The text description of UsageFlags.

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

SSLCertUsageFlags Property (IPWorksEDI_MLLPServer Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_mllpserver_get($res, 41 );

Default Value

0

Remarks

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

Please see the Usage property for a text representation of UsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksEDI_MLLPServer Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_mllpserver_get($res, 42 );

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

SSLCertSubject Property (IPWorksEDI_MLLPServer Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 43 );
ipworksedi_mllpserver_set($res, 43, $value );

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

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

Data Type

String

SSLCertEncoded Property (IPWorksEDI_MLLPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 44 );
ipworksedi_mllpserver_set($res, 44, $value );

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.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function getSSLEnabled();
public function setSSLEnabled($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 45 );
ipworksedi_mllpserver_set($res, 45, $value );

Default Value

false

Remarks

This property 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 (IPWorksEDI_MLLPServer Class)

The MLLP version to use.

Object Oriented Interface

public function getVersion();
public function setVersion($value);

Procedural Interface

ipworksedi_mllpserver_get($res, 46 );
ipworksedi_mllpserver_set($res, 46, $value );

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 (IPWorksEDI_MLLPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_mllpserver_do_config($res, $configurationstring);

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.

Disconnect Method (IPWorksEDI_MLLPServer Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksedi_mllpserver_do_disconnect($res, $connectionid);

Remarks

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

DoEvents Method (IPWorksEDI_MLLPServer Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_mllpserver_do_doevents($res);

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.

Interrupt Method (IPWorksEDI_MLLPServer Class)

This method interrupts a synchronous send to the remote host.

Object Oriented Interface

public function doInterrupt($connectionid);

Procedural Interface

ipworksedi_mllpserver_do_interrupt($res, $connectionid);

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.

Reset Method (IPWorksEDI_MLLPServer Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_mllpserver_do_reset($res);

Remarks

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

Send Method (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function doSend($connectionid);

Procedural Interface

ipworksedi_mllpserver_do_send($res, $connectionid);

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

Shutdown Method (IPWorksEDI_MLLPServer Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksedi_mllpserver_do_shutdown($res);

Remarks

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

StartListening Method (IPWorksEDI_MLLPServer Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksedi_mllpserver_do_startlistening($res);

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.

StopListening Method (IPWorksEDI_MLLPServer Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksedi_mllpserver_do_stoplistening($res);

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.

AckIn Event (IPWorksEDI_MLLPServer Class)

Fires immediately after receiving an acknowledgement from a client.

Object Oriented Interface

public function fireAckIn($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 1, array($this, 'fireAckIn'));

Parameter List

 'connectionid'
 'accepted'

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 (IPWorksEDI_MLLPServer Class)

Fires immediately before sending an acknowledgement to a client.

Object Oriented Interface

public function fireAckOut($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 2, array($this, 'fireAckOut'));

Parameter List

 'connectionid'
 'accept'

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 3, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 4, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

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 (IPWorksEDI_MLLPServer Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 5, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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 (IPWorksEDI_MLLPServer Class)

Fires after incoming HL7 data finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 6, array($this, 'fireEndTransfer'));

Parameter List

 'connectionid'

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 (IPWorksEDI_MLLPServer Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

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 (IPWorksEDI_MLLPServer Class)

Provides logging information.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 'logtype'

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 9, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 10, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

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:

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:

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

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:

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

SSLStatus Event (IPWorksEDI_MLLPServer Class)

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

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

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

StartTransfer Event (IPWorksEDI_MLLPServer Class)

Fires before incoming HL7 data begins transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 12, array($this, 'fireStartTransfer'));

Parameter List

 'connectionid'

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 (IPWorksEDI_MLLPServer Class)

Fires during incoming data transfer.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_mllpserver_register_callback($res, 13, array($this, 'fireTransfer'));

Parameter List

 'connectionid'
 'bytestransferred'
 'data'

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)

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

MLLPServer Errors

TCPClient Errors

TCP/IP Errors