MLLPClient Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

nsoftware.IPWorksEDI.Mllpclient

Remarks

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

Connecting

To begin using the MLLPClient component, 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:

• Call the SetInputStream method, passing it a stream with HL7 data.
• 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 component's AckIn event to fire.

Sending Data Example

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

Receiving Data

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

When the MLLPClient component 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 component will be stored in one of the following ways:

• If an output stream has been specified using the SetOutputStream method, the data is written to that stream.
• Otherwise, 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.