MLLPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEDI_MLLPClient

Procedural Interface

 ipworksedi_mllpclient_open();
 ipworksedi_mllpclient_close($res);
 ipworksedi_mllpclient_register_callback($res, $id, $function);
 ipworksedi_mllpclient_get_last_error($res);
 ipworksedi_mllpclient_get_last_error_code($res);
 ipworksedi_mllpclient_set($res, $id, $index, $value);
 ipworksedi_mllpclient_get($res, $id, $index);
 ipworksedi_mllpclient_do_config($res, $configurationstring);
 ipworksedi_mllpclient_do_connect($res);
 ipworksedi_mllpclient_do_disconnect($res);
 ipworksedi_mllpclient_do_doevents($res);
 ipworksedi_mllpclient_do_interrupt($res);
 ipworksedi_mllpclient_do_reset($res);
 ipworksedi_mllpclient_do_send($res);

Remarks

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

Connecting

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

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

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

Sending Data

Once connected, specify the HL7 data to send by doing one of the following:

• Set the InputFilename property to the path of a file with HL7 data.
• Set the HL7 data directly to the InputData property.

Once the data has been specified, simply call the Send method to send the HL7 data to the server. Once the server has received the data, it will respond with an acknowledgement, causing the class's AckIn event to fire.

Sending Data Example mllpClient.InputData = "HL7Data"; mllpClient.Send();

Receiving Data

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

When the MLLPClient class is receiving data, immediately before data transfer begins the StartTransfer event fires. During data transfer, one or more Transfer events will fire. When data transfer is complete, the EndTransfer event fires. Any errors during data delivery will cause the Error event to fire.

Immediately before the client acknowledgement is sent the AckOut event fires. The Accept parameter of this event is used to determine the type of acknowledgement (ACK or NAK) to send back to the server.

HL7 data received by the MLLPClient class will be stored in one of the following ways:

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

Property List

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

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.

Connected Property (IPWorksEDI_MLLPClient Class)

This property triggers a connection or disconnection.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 1 );


ipworksedi_mllpclient_set($res, 1, $value );

Default Value

false

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (IPWorksEDI_MLLPClient Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 2 );


ipworksedi_mllpclient_set($res, 2, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksEDI_MLLPClient Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 3 );


ipworksedi_mllpclient_set($res, 3, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksEDI_MLLPClient Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 4 );


ipworksedi_mllpclient_set($res, 4, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksEDI_MLLPClient Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 5 );


ipworksedi_mllpclient_set($res, 5, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksEDI_MLLPClient Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 6 );


ipworksedi_mllpclient_set($res, 6, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksEDI_MLLPClient Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 7 );


ipworksedi_mllpclient_set($res, 7, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

InputData Property (IPWorksEDI_MLLPClient Class)

The raw HL7 data to send.

Object Oriented Interface

public function getInputData();


public function setInputData($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 8 );


ipworksedi_mllpclient_set($res, 8, $value );

Default Value

''

Remarks

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 InputFilename property.
• The data set to the InputData property.

This property is not available at design time.

Data Type

Binary String

InputFilename Property (IPWorksEDI_MLLPClient Class)

The path of a file containing HL7 data to send.

Object Oriented Interface

public function getInputFilename();


public function setInputFilename($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 9 );


ipworksedi_mllpclient_set($res, 9, $value );

Default Value

''

Remarks

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 InputFilename property.
• The data set to the InputData property.

This property is not available at design time.

Data Type

String

KeepAlive Property (IPWorksEDI_MLLPClient Class)

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

Object Oriented Interface

public function getKeepAlive();


public function setKeepAlive($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 10 );


ipworksedi_mllpclient_set($res, 10, $value );

Default Value

false

Remarks

The KeepAlive enables the SO_KEEPALIVE option on the socket. 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.

Data Type

Boolean

LocalHost Property (IPWorksEDI_MLLPClient 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_mllpclient_get($res, 11 );


ipworksedi_mllpclient_set($res, 11, $value );

Default Value

''

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

LocalPort Property (IPWorksEDI_MLLPClient Class)

The TCP port in the local host where the class binds.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 12 );


ipworksedi_mllpclient_set($res, 12, $value );

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

OutputData Property (IPWorksEDI_MLLPClient Class)

The raw HL7 data received.

Object Oriented Interface

public function getOutputData();

Procedural Interface

ipworksedi_mllpclient_get($res, 13 );

Default Value

''

Remarks

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

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 OutputFilename property.
• The OutputData property.

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

Data Type

Binary String

OutputFilename Property (IPWorksEDI_MLLPClient Class)

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

Object Oriented Interface

public function getOutputFilename();


public function setOutputFilename($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 14 );


ipworksedi_mllpclient_set($res, 14, $value );

Default Value

''

Remarks

This property is used to specify a path to a file in which to store HL7 data received from the MLLP server.

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 OutputFilename property.
• The OutputData property.

This property is not available at design time.

Data Type

String

RemoteHost Property (IPWorksEDI_MLLPClient Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Object Oriented Interface

public function getRemoteHost();


public function setRemoteHost($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 15 );


ipworksedi_mllpclient_set($res, 15, $value );

Default Value

''

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Data Type

String

RemotePort Property (IPWorksEDI_MLLPClient Class)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Object Oriented Interface

public function getRemotePort();


public function setRemotePort($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 16 );


ipworksedi_mllpclient_set($res, 16, $value );

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SSLAcceptServerCertEncoded Property (IPWorksEDI_MLLPClient Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 18 );


ipworksedi_mllpclient_set($res, 18, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (IPWorksEDI_MLLPClient Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 46 );


ipworksedi_mllpclient_set($res, 46, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IPWorksEDI_MLLPClient Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 62 );


ipworksedi_mllpclient_set($res, 62, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksEDI_MLLPClient 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_mllpclient_get($res, 63 );


ipworksedi_mllpclient_set($res, 63, $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_MLLPClient Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 64 );


ipworksedi_mllpclient_set($res, 64, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (IPWorksEDI_MLLPClient Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 65 );


ipworksedi_mllpclient_set($res, 65, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLEnabled Property (IPWorksEDI_MLLPClient Class)

Whether TLS/SSL is enabled.

Object Oriented Interface

public function getSSLEnabled();


public function setSSLEnabled($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 73 );


ipworksedi_mllpclient_set($res, 73, $value );

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

SSLServerCertEncoded Property (IPWorksEDI_MLLPClient Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksedi_mllpclient_get($res, 75 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (IPWorksEDI_MLLPClient Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 102 );


ipworksedi_mllpclient_set($res, 102, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Version Property (IPWorksEDI_MLLPClient Class)

The MLLP version to use.

Object Oriented Interface

public function getVersion();


public function setVersion($value);

Procedural Interface

ipworksedi_mllpclient_get($res, 103 );


ipworksedi_mllpclient_set($res, 103, $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_MLLPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Connect Method (IPWorksEDI_MLLPClient Class)

This method connects to a remote host.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_mllpclient_do_connect($res);

Remarks

This method connects to the remote host specified by RemoteHost and RemotePort. For instance: component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect();

Disconnect Method (IPWorksEDI_MLLPClient Class)

This method disconnects from the remote host.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_mllpclient_do_disconnect($res);

Remarks

This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.

DoEvents Method (IPWorksEDI_MLLPClient Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

This method interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_mllpclient_do_interrupt($res);

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Reset Method (IPWorksEDI_MLLPClient Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_mllpclient_do_reset($res);

Remarks

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

Send Method (IPWorksEDI_MLLPClient Class)

Sends HL7 data to the MLLP server.

Object Oriented Interface

public function doSend();

Procedural Interface

ipworksedi_mllpclient_do_send($res);

Remarks

The Send method sends the string or byte array in InputData to the specified server. Alternatively, you can set InputFilename to the name of a file with HL7 contents.

Before calling this method, set the RemoteHost and RemotePort properties to the server credentials and Connect or set Connected to True.

Sending Data Example mllpClient.InputData = "HL7Data"; mllpClient.Send();

If the data was received by the server, the class will receive a response and the AckIn event will fire.

AckIn Event (IPWorksEDI_MLLPClient Class)

Fires immediately after receiving an acknowledgement from the server.

Object Oriented Interface

public function fireAckIn($param);

Procedural Interface

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

Parameter List

 'accepted'

Remarks

This event fires immediately after receiving an acknowledgement (positive or negative) from the MLLP server.

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

Fires immediately before sending an acknowledgement to the server.

Object Oriented Interface

public function fireAckOut($param);

Procedural Interface

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

Parameter List

 'accept'

Remarks

This event fires immediately before the class sends an acknowledgement to the MLLP server.

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

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 '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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorksEDI_MLLPClient Class)

This event is fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksedi_mllpclient_register_callback($res, 4, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (IPWorksEDI_MLLPClient Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

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

Parameter List

 '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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksEDI_MLLPClient Class)

Fires after incoming HL7 data finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

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

Parameter List

Remarks

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

Error Event (IPWorksEDI_MLLPClient Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksEDI_MLLPClient Class)

Provides logging information.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

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

Parameter List

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

LogType specifies the type of log message. Possible values are:

• INFO
• VERBOSE
• DEBUG

LogMessage is the log message.

SSLServerAuthentication Event (IPWorksEDI_MLLPClient Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_mllpclient_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or 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). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorksEDI_MLLPClient Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_mllpclient_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorksEDI_MLLPClient Class)

Fires before incoming HL7 data begins transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_mllpclient_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

Remarks

This event fires before incoming HL7 data begins transferring.

Transfer Event (IPWorksEDI_MLLPClient Class)

Fires during incoming data transfer.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_mllpclient_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'bytestransferred'
 'data'

Remarks

This event fires one or more times while incoming 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 (MLLPClient Class)

MLLPCLIENT Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (MLLPClient Class)

MLLPClient Errors

TCPClient Errors

TCP/IP Errors