SMSCserverCIMD2

int cimd2InitializeServer(string LocalHost, int LocalPort, string ExtendedParameters);

int cimd2FinalizeServer();

int tcpAcceptConnection(int ClientID);

int tcpCloseConnection(int ClientID);

void tcpCloseAllConnections();

int cimd2SendRAW(uint ClientID, uint TransactionNumber, uint OperationCode, string Payload);

int cimd2SendLoginResponse(uint ClientID, uint TransactionNumber, uint ErrorCode, string ErrorMessage);

int cimd2SendDeliverMessage(uint ClientID, uint TransactionNumber, string Destination, string Originator, Widestring Content, EncodingEnum Encoding, string UserDataHeader, SubmitOption Options, DateTime TimeStamp, string ExtendedParameters, ref List< uint > TransactionNumbers);

int cimd2SendDeliverStatusReport(int ClientID, int TransactionNumber, DateTime MessageTimeStamp, string Destination, int StatusCode, int StatusErrorCode, DateTime TimeStamp, string ExtendedParameters);

int cimd2SendSubmitMessageResponse(uint ClientID, uint TransactionNumber, string Destination, DateTime TimeStamp, uint ErrorCode, string ErrorMessage);

public delegate void tcpConnectedEvent(TObject sender, tcpConnectedEventArgs e);

Parameters

Sender

Object sending the event.

e

Object encapsulating event parameters.

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

string RemoteHost

IP address of the remote client that is about to connect to the server. In dotted numeric representation (e.g. "192.168.8.16").

int RemotePort

Port number of the remote client that is about to connect to the server.

public delegate void tcpDisconnectedEvent(TObject sender, tcpDisconnectedEventArgs e);

Parameters

Sender

Object sending the event.

e

Object encapsulating event parameters.

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

int Reason

When the result is zero the connection has been disconnected by remote party. When the result is -1 then connection has been ended by the component itself, because inproperly formatted response has been received during the attempt to communicate with the remote party. Positive value means Network Error Code.

public delegate void cimd2RAWReceivedEvent(TObject sender, cimd2RAWReceivedEventArgs e);

Parameters

Sender

Object sending the event.

e

Object encapsulating event parameters.

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

uint TransactionNumber

Identifier of the request/response sequence exchanged between CIMD2 client and server. Response should have the same Transaction Number as request. Transaction Numbers are generated independently by client and server and should be unique for each peer.

int Code

This field identifies the particular CIMD2 operation that is contained within the frame.

string Payload

Protocol frame (also referred as PDU, Protocol Data Unit) consists of header (which contains Transaction Number, Command ID and Command Status) and message data. This property contains message data part, without header, in hexadecimal representation (each two hexadecimal digits represent one byte of data).

public delegate void cimd2LoginReceivedEvent(TObject sender, cimd2LoginReceivedEventArgs e);

Parameters

Sender

Object sending the event.

e

Object encapsulating event parameters.

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

uint TransactionNumber

Identifier of the request/response sequence exchanged between CIMD2 client and server. Response should have the same Transaction Number as request. Transaction Numbers are generated independently by client and server and should be unique for each peer.

string UserIdentity

string Password

public delegate void cimd2DeliverResponseReceivedEvent(TObject sender, cimd2DeliverResponseReceivedEventArgs e);

Parameters

Sender

Object sending the event.

e

Object encapsulating event parameters.

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

uint TransactionNumber

Identifier of the request/response sequence exchanged between CIMD2 client and server. Response should have the same Transaction Number as request. Transaction Numbers are generated independently by client and server and should be unique for each peer.

uint ErrorCode

Error Code as defined in CIMD2 Error Codes chapter Error Code.

public delegate void cimd2SubmitMessageReceivedEvent(TObject sender, cimd2SubmitMessageReceivedEventArgs e);

Parameters

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to received protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

uint TransactionNumber

Identifier of the request/response sequence exchanged between CIMD2 client and server. Response should have the same Transaction Number as request. Transaction Numbers are generated independently by client and server and should be unique for each peer.

string Destination

Usually this is mobile phone number in canonical format.

string Originator

Usually this is is number of the SMSC's account (a short GSM number). This parameter can also be an alphanumeric string or phone number.

string Content

This can be ASCII characters string or hexadecimally encoded binary content.

EncodingEnum Encoding

Possible values as per EncodingEnum type definition.

SubmitOption Options

Options that can be set to submitted message as per SubmitOptionEnum type definition. More than one option can be set at the same time by using the OR operator on selected option values.

string UserDataHeader

If the message received contains the User Data Header (UDH), it will be returned in this field as hexadecimally encoded binary content, for example: "06050415831583". If the message does not have UDH empty string is returned.

DateTime DeliveryTime

Contains the message delivery time. Works according to Options parameter. If Options parameter contains the flag soDeliveryTimeRelative then the delivery time is considered relative to the time when message was submitted to the SMSC. If the Options parameter contains the flag soDeliveryTimeAbsolute then the delivery time is considered absolute in the machine local time zone.

DateTime ValidityPeriod

Contains the message validity time. Works according to Options parameter. If Options parameter contains the flag soValidityPeriodRelative then the message validity time is considered relative to the submission to the SMSC. If Options parameter contains the flag soValidityPeriodAbsolute then the message validity time is considered absolute in the machine local time zone. If both options are specified absolute time is set. When set as relative the time the maximum period is 31 days. Anything above wil be shortened to 31 days.

string ExtendedParameters

Allows to retrieve the additional parameters from the message received. For the description and syntax of parameters that can be retreived this way see Extended Parameters.

public delegate void cimd2SubmitMessageCompletedEvent(TObject sender, cimd2SubmitMessageCompletedEventArgs e);

Parameters

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to Completed protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

uint TransactionNumber

Identifier of the request/response sequence exchanged between CIMD2 client and server. Response should have the same Transaction Number as request. Transaction Numbers are generated independently by client and server and should be unique for each peer.

string Destination

Usually this is mobile phone number in canonical format.

string Originator

Usually this is is number of the SMSC's account (a short GSM number). This parameter can also be an alphanumeric string or phone number.

string Content

This can be ASCII characters string or hexadecimally encoded binary content.

EncodingEnum Encoding

Possible values as per EncodingEnum type definition.

SubmitOption Options

Options that can be set to submitted message as per SubmitOptionEnum type definition. More than one option can be set at the same time by using the OR operator on selected option values.

string UserDataHeader

If the message Completed contains the User Data Header (UDH), it will be returned in this field as hexadecimally encoded binary content, for example: "06050415831583". If the message does not have UDH empty string is returned.

DateTime DeliveryTime

Contains the message delivery time. Works according to Options parameter. If Options parameter contains the flag soDeliveryTimeRelative then the delivery time is considered relative to the time when message was submitted to the SMSC. If the Options parameter contains the flag soDeliveryTimeAbsolute then the delivery time is considered absolute in the machine local time zone.

DateTime ValidityPeriod

Contains the message validity time. Works according to Options parameter. If Options parameter contains the flag soValidityPeriodRelative then the message validity time is considered relative to the submission to the SMSC. If Options parameter contains the flag soValidityPeriodAbsolute then the message validity time is considered absolute in the machine local time zone. If both options are specified absolute time is set. When set as relative the time the maximum period is 31 days. Anything above wil be shortened to 31 days.

string ExtendedParameters

Allows to retrieve the additional parameters from the message Completed. For the description and syntax of parameters that can be retreived this way see Extended Parameters.

<> List TimeStamps

Message TimeStamp(s) returned to the SMSC for the messages that form the completed message. They should be used to later deliver Status Reports using ucpSendDeliverStatusReport.

public delegate void cimd2TraceProtocolCallback(TObject Sender, cimd2TraceProtocolCallbackArgs e);

Parameters

int ClientID

Component can serve multiple client connections. Each connection has uniqe, numerical identifier. This identifier is used to send responses to Completed protocol messages and to send protocol messages to particular client. If the value returned by ClientID equals -1 then the connection to which event is reported has been disconnected prior to processing of the message.

string FromAddress

Colon separated IP address and port number (IP:Port).

string ToAddress

Colon separated IP address and port number (IP:Port).

int Operation

This field identifies type of particular CIMD2 message which indicates what operation data is contained within Protocol Data Unit (PDU).

int OperationType

Identifier of the request/response sequence exchanged between CIMD2 client and server.

string PDU

Protocol Data Unit (PDU) message data in hexadecimal representation (each two hexadecimal digits represent one byte of data).

public int KeepAliveInterval { get; set; }

public int ThrottleRate { get; set; }