CIMDLib Manual Beta

CIMDLib Manual
v1.00j beta
CIMDLib Manual v1.00j
TABLE OF CONTENT
1. Library Packages
a. CIMDService
i. CIMDServiceErrorCode
b. CIMDService.CIMDClient
i. CIMDClient
c. CIMDService.CIMDServer
i. CIMDServer
ii. CIMDServerListener
iii. UserProfile
d. CIMDService.CIMDClient.EventArg
i. CIMDService Events
1. ConnectingInfoEventArgs
2. ConnectedInfoEventArgs
3. DisconnectingInfoEventArgs
4. DisconnectedInfoEventArgs
5. SendInfoEventArgs
6. ReceiveInfoEventArgs
7. GeneralInfoEventArgs
8. ErrorInfoEventArgs
ii. CIMDMessage Event
1. LoginResponseEventArgs
2. LogoutResponseEventArgs
3. SubmitMessageResponseEventArgs
4. EnquireMessageStatusResponseEventArgs
5. DeliveryRequestResponseEventArgs
6. CancelMessageResponseEventArgs
7. SetResponseEventArgs
8. GetResponseEventArgs
9. AliveResponseEventArgs
10. GeneralErrorResponseEventArgs
11. NACKResponseEventArgs
12. DeliverMessageEventArgs
13. DeliverStatusReportEventArgs
e. CIMDService.CIMDClient.Messages
i. SubmitMessage
ii. EnquireMessageStatus
iii. DeliveryRequest
iv. CancelMessage
v. Set
vi. Get
vii. DeliveryMessage
viii. DeliveryStatus
f. CIMD2
i. CIMDProtocol
ii. CIMDPacket
w-lib@hotmail.com 2
iii. CIMDParam
iv. CIMDParameter
v. GSMCharacterSet
vi. CIMDOperationCodeRequest
vii. CIMDOperationCodeResponse
viii. CIMDParameterCode
ix. CIMDStatusCode
x. CIMDStatusErrorCode
xi. CIMDErrorCode
xii. CIMDStatusReportRequest
g. CIMD2.Utils
i. CIMDUtils
ii. CIMDDataMessage
iii. CIMDConversion
2. Example
3. Reference
w-lib@hotmail.com 3
LIBRARY PACKAGES
Class CIMDService.CIMDServiceErrorCode
Package: CIMDService
Class: CIMDServiceErrorCode
Public Properties
-
Public Methods
Function Retu
GetCIMDServiceErrorCodeText (int error_code)
Description: Get CIMDService error message
Strin
Parameters:
error_code – error code
Class CIMDService.CIMDClient
Package: CIMDService.CIMDClient
Class: CIMDClient
Public Properties
Name Type Set/Get Description
HOST String Both Destination address e.g. localhost
PORT int Both Destination port
USER String Both Identity used to login. Max. 32 ch
PASSWORD String Both Password used to login. Max. 32
Spaces are not allowed.
SUBADDR int Both Defines a unique index for applic
correct delivery of status reports
application are connected.
WINDOWS_SIZE int Both Defines the window size used by
messages.
RECONNECT_TIME int Both Time wait for reconnecting. (unit
Default value is 5 sec.
ECHO_TIME int Both Time wait for sending echo (whe
ECHO_TIMEOUT int Both Time wait for echo reply (unit in
MAX_ECHO_RETRY int Both Number of retry sending echo.
Default value is 3 time.
SEND object Set Send Object to send queue.
w-lib@hotmail.com 4
Supported object:
SubmitMessage
EnquireMessageStatus
DeliveryRequest
CancelMessage
Set
Get
SEND_COUNT int Get Number of object in send queue.
DELIVERY_MESSAGE DeliveryMessage Get Get DeliveryMessage from messa
PEEK_DELIVERY_MESSAGE DeliveryMessage Get Get DeliveryMessage from messa
MESSAGE_COUNT int Get Number of message in message q
DELIVERY_STATUS DeliveryStatus Get Get DeliveryMessage from status
PEEK_DELIVERY_STATUS DeliveryStatus Get Get DeliveryMessage from status
DELIVERY_STATUS_COUNT int Get Number of status message in stat
Public Methods
Function Retu
CIMDClient()
CIMDClient(String host, int port, String user, String password)
CIMDClient(String host, int port, String user, String password, int sub_addr, int window_size)
Description: constructor
Parameters:
host - destination address e.g. localhost, xxx.xxx.xxx.xxx.
void
port - destination port.
user - identity used to login. Max. 32 characters. Spaces are not allowed.
password - password used to login. Max. 32 characters. Spaces are not allowed.
sub_addr - defines a unique index for application instance. This is useful for correct delivery of
status reports when multiple instances of the same application are connected.
window_size - defines the window size used by the application for submitting messages.
Connect()
Connect(String host, int port, String user, String password)
Connect(String host, int port, String user, String password, int sub_addr, int window_size)
Description: start service and connect to server.
Parameters:
host - destination address e.g. localhost, xxx.xxx.xxx.xxx.
void
port - destination port.
user - identity used to login. Max. 32 characters. Spaces are not allowed.
password - password used to login. Max. 32 characters. Spaces are not allowed.
sub_addr - defines a unique index for application instance. This is useful for correct delivery of
status reports when multiple instances of the same application are connected.
window_size - defines the window size used by the application for submitting messages.
Disconnect()
void
Description: stop service and disconnect from server by sending logout.
Restart()
void
Description: restart service and reset connection
Stop()
void
Description: stop service and disconnect from server
Destroy()
void
Description: force terminate service and connection
w-lib@hotmail.com 5
IsLogin()
boole
Description: check connection login
IsServiceStarted()
boole
Description: check service started
IsServiceStarting() boole
Description: check service starting
IsServiceStoped()
boole
Description: check service stopped
Public Business Methods

Function Retu
SendSMS(String sender, String receiver, String msg)
SendSMS(String id, String sender, String receiver, String msg)
Description: send sms message.
- auto concatenated
- auto check msg type (Eng/Unicode)
Parameters:
id – transaction reference number. int
sender – sender name. This parameter is a string of maximum 11 characters, where each
character byte can have the following values: 32-126 inclusive, BUT NOT ALLOWED: 36, 64,
93, 95, 96, 125, that is, included are a few punctuation marks, space, a-z, A-Z and 0-9.
receiver – receiver msisdn.
msg – string message to send.
Return: number of sms.
Public Events
Event Subscribe/Unsubscribe/Clear Subscribe Function and Descript
OnGeneralInfo AddGeneralInfoListener(OnGeneralInfoListener listener)
RemoveGeneralInfoListener(OnGeneralInfoListener listener)
ClearGeneralInfoListener()
Description: fire when service has general information such as serv
OnErrorInfo AddErrorInfoListener(OnErrorInfoListener listener)
RemoveErrorInfoListener(OnErrorInfoListener listener)
ClearErrorInfoListener()
Description: fire when service has error occur
OnConnectingInfo AddConnectingInfoListener(OnConnectingInfoListener listener)
RemoveConnectingInfoListener(OnConnectingInfoListener listene
ClearConnectingInfoListener()
Description: fire when service is connecting
OnConnectedInfo AddConnectedInfoListener(OnConnectedInfoListener listener)
RemoveConnectedInfoListener(OnConnectedInfoListener listener)
ClearConnectedInfoListener()
Description: fire when service connected
OnDisconnectingInfo AddDisconnectingInfoListener(OnDisconnectingInfoListener listen
RemoveDisconnectingInfoListener(OnDisconnectingInfoListener l
ClearDisconnectingInfoListener()
Description: fire when service is disconnecting
OnDisconnectedInfo AddDisconnectedInfoListener(OnDisconnectedInfoListener listene
RemoveDisconnectingInfoListener(OnDisconnectedInfoListener li
w-lib@hotmail.com 6
ClearDisconnectedInfoListener()
Description: fire when service disconnected
OnSendInfo AddSendInfoListener(OnSendInfoListener listener)
RemoveSendInfoListener(OnSendInfoListener listener)
ClearSendInfoListener()
Description: fire when service send any packet to server
OnReceiveInfo AddReceiveInfoListener(OnReceiveInfoListener listener)
RemoveReceiveInfoListener(OnReceiveInfoListener listener)
ClearReceiveInfoListener()
Description: fire when service receive any packet from server
OnLoginResponse AddLoginResponseListener(OnLoginResponseListener listener)
RemoveLoginResponseListener(OnLoginResponseListener listene
ClearLoginResponseListener()
Description: fire when service receive login response (51) from ser
OnLogoutResponse AddLogoutResponseListener(OnLogoutResponseListener listener)
RemoveLogoutResponseListener(OnLogoutResponseListener liste
ClearLogoutResponseListener()
Description: fire when service receive logout response (52) from se
OnSubmitMessageResponse AddSubmitMessageResponseListener(OnSubmitMessageResponse
RemoveSubmitMessageResponseListener(OnSubmitMessageResp
ClearSubmitMessageResponseListener()
Description: fire when service receive submit message response (53
OnEnquireMessageStatusResponse AddEnquireMessageStatusResponseListener(OnEnquireMessageS
RemoveEnquireMessageStatusResponseListener(OnEnquireMessa
ClearEnquireMessageStatusResponseListener()
Description: fire when service receive enquire status response (54)
OnDeliveryRequestResponse AddDeliveryRequestResponseListener(OnDeliveryRequestRespon
RemoveDeliveryRequestResponseListener(OnDeliveryRequestRes
ClearDeliveryRequestResponseListener()
Description: fire when service receive delivery request response (5
OnCancelMessageResponse AddCancelMessageResponseListener(OnCancelMessageResponse
RemoveCancelMessageResponseListener(OnCancelMessageRespo
ClearCancelMessageResponseListener()
Description: fire when service receive cancel message response (56
OnSetResponse AddSetResponseListener(OnSetResponseListener listener)
RemoveSetResponseListener(OnSetResponseListener listener)
ClearSetResponseListener()
Description: fire when service receive set response (58) from serve
OnGetResponse AddGetResponseListener(OnGetResponseListener listener)
RemoveGetResponseListener(OnGetResponseListener listener)
ClearGetResponseListener()
Description: fire when service receive get response (59) from serve
OnAliveResponse AddAliveResponseListener(OnAliveResponseListener listener)
RemoveAliveResponseListener(OnAliveResponseListener listener
ClearAliveResponseListener()
Description: fire when service receive alive response (90) from ser
OnDeliverMessage AddDeliverMessageListener(OnDeliverMessageListener listener)
RemoveDeliverMessageListener(OnDeliverMessageListener listen
ClearDeliverMessageListener()
Description: fire when service receive deliver message (23) from se
w-lib@hotmail.com 7
OnDeliverStatusReport AddDeliverStatusReportListener(OnDeliverStatusReportListener l
RemoveDeliverStatusReportListener(OnDeliverStatusReportListen
ClearDeliverStatusReportListener()
Description: fire when service receive deliver status report (20) fro
OnGeneralErrorResponse AddGeneralErrorResponseListener(OnGeneralErrorResponseListe
RemoveGeneralErrorResponseListener(OnGeneralErrorResponseL
ClearGeneralErrorResponseListener()
Description: fire when service receive general error response (98) f
OnNACKResponse AddNACKResponseListener(OnNACKResponseListener listener)
RemoveNACKResponseListener(OnNACKResponseListener listen
ClearNACKResponseListener()
Description: fire when service receive NACK response (99) from s
* see more detail in CIMDService.CIMDClient.EventArgs
Class CIMDService.CIMDSerer
Package: CIMDService.CIMDServer
Class: CIMDServer
Public Properties
USER UserProfile Get User Profile of current connection
USER_ID String Get User ID of current connection.
CONNECTING_DATE Date Get Connecting Date of current conne
ECHO_TIMEOUT int Both Time out for idle connection. (de
SEND object Set Send Object to send queue.
Supported object:
DeliveryMessage
DeliveryStatusReport
SEND_COUNT int Get Number of message in send queu
Public Methods
Function Retu
IsLogin()
boole
Start ()
void
Description: start service
Stop()
void
Description: stop service
Public Events
w-lib@hotmail.com 8
Description: fire when client is connecting
Description: fire when client connected
Description: fire when client is disconnecting
Description: fire when client disconnected
OnLoginRequest AddLoginRequestListener(OnLoginRequestListener listener)
RemoveLoginRequestListener(OnLoginRequestListener listener)
ClearLoginRequestListener()
Description: fire when service receive login request (01) from clien
OnLogoutRequest AddLogoutRequestListener(OnLogoutRequestListener listener)
RemoveLogoutRequestListener(OnLogoutRequestListener listener
ClearLogoutRequestListener()
Description: fire when service receive logout request (02) from clie
OnSubmitMessageRequest AddSubmitMessageRequestListener(OnSubmitMessageRequestLis
RemoveSubmitMessageRequestListener(OnSubmitMessageReque
ClearSubmitMessageRequestListener()
Description: fire when service receive submit message qequest (03
OnEnquireMessageStatusRequest AddEnquireMessageStatusRequestListener(OnEnquireMessageSta
RemoveEnquireMessageStatusRequestListener(OnEnquireMessag
ClearEnquireMessageStatusRequestListener()
Description: fire when service receive enquire status request (04) fr
OnDeliveryRequestRequest AddDeliveryRequestRequestListener(OnDeliveryRequestRequestL
RemoveDeliveryRequestRequestListener(OnDeliveryRequestRequ
ClearDeliveryRequestRequestListener()
Description: fire when service receive delivery request request (05)
OnCancelMessageRequest AddCancelMessageRequestListener(OnCancelMessageRequestLis
RemoveCancelMessageRequestListener(OnCancelMessageReques
ClearCancelMessageRequestListener()
Description: fire when service receive cancel message request (06)
w-lib@hotmail.com 9
OnSetRequest AddSetRequestListener(OnSetRequestListener listener)

RemoveSetRequestListener(OnSetRequestListener listener)
ClearSetRequestListener()
Description: fire when service receive set request (08) from client
OnGetRequest AddGetRequestListener(OnGetRequestListener listener)
RemoveGetRequestListener(OnGetRequestListener listener)
ClearGetRequestListener()
Description: fire when service receive get request (09) from client
OnAliveRequest AddAliveRequestListener(OnAliveRequestListener listener)
RemoveAliveRequestListener(OnAliveRequestListener listener)
ClearAliveRequestListener()
Description: fire when service receive alive request (40) from clien
OnDeliverMessageResponse AddDeliverMessageResponseListener(OnDeliverMessageListener
RemoveDeliverMessageResponseListener(OnDeliverMessageListe
ClearDeliverMessageResponseListener()
Description: fire when service receive deliver message response (7
Description: fire when service receive deliver status report respons
Description: fire when service receive NACK response (99) from c
* see more detail in CIMDService.CIMDServer.EventArgs
Class CIMDService.CIMDServerListener
Class: CIMDServerListener
Public Properties
PORT int Both Listener port.
USER_LIST UserProfile/ Both User Profile Lists
Hastable
MAX_CONNECTION int Get Maximum concurrent connection
CONNECTION_LIMIT int Both Limit of concurrent connection.
CONNECTION_COUNT int Get Current concurrent connection.
AUTO_MANNAGE_LOGIN boolean Both Mode Auto Mannage Login. (US
automatic check login with user p
AUTO_MANNAGE_LOGOUT boolean Both Mode Auto Mannage Logout
automatic send logout response
AUTO_MANNAGE_SET boolean Both Mode Auto Mannage Set
automatic check permisioion with
response
AUTO_MANNAGE_GET boolean Both Mode Auto Mannage Get
automatic check permisioion with
w-lib@hotmail.com 10
response
AUTO_MANNAGE_ALIVE boolean Both Mode Auto Mannage Alive
automatic send alive response
Public Methods
Function Retu
CIMDServerListener()
CIMDServerListener(int port)
Description: construtor void
Parameters:
port – port for listening
Send (String user_id, Object msg)
Description: send message to client
Parameters: boole
user_id* – user id that want to be checking login
msg – message (Delivery Message or Delivery Status Report Message)
Listening()
Listening(int port)
Description: start service listening void
Parameters:
port – port for listening
StopListening()
void
Description: stop service listening
IsListening()
boole
Description: check service is listening
IsLogin(String user_id)
boole
Parameters:
user_id* – user id that want to be checking login
*user_id is user_identity + subaddr
Public Events
Description: fire when client is connecting
Description: fire when client connected

Description: fire when client is disconnecting
Description: fire when client disconnected
OnLoginRequest AddLoginRequestListener(OnLoginRequestListener listener)
RemoveLoginRequestListener(OnLoginRequestListener listener)
ClearLoginRequestListener()
Description: fire when service receive login request (01) from clien
OnLogoutRequest AddLogoutRequestListener(OnLogoutRequestListener listener)
RemoveLogoutRequestListener(OnLogoutRequestListener listener
ClearLogoutRequestListener()
Description: fire when service receive logout request (02) from clie
OnSubmitMessageRequest AddSubmitMessageRequestListener(OnSubmitMessageRequestLis
RemoveSubmitMessageRequestListener(OnSubmitMessageReque
ClearSubmitMessageRequestListener()
Description: fire when service receive submit message qequest (03
OnEnquireMessageStatusRequest AddEnquireMessageStatusRequestListener(OnEnquireMessageSta
RemoveEnquireMessageStatusRequestListener(OnEnquireMessag
ClearEnquireMessageStatusRequestListener()
Description: fire when service receive enquire status request (04) fr
OnDeliveryRequestRequest AddDeliveryRequestRequestListener(OnDeliveryRequestRequestL
RemoveDeliveryRequestRequestListener(OnDeliveryRequestRequ
ClearDeliveryRequestRequestListener()
Description: fire when service receive delivery request request (05)
OnCancelMessageRequest AddCancelMessageRequestListener(OnCancelMessageRequestLis
RemoveCancelMessageRequestListener(OnCancelMessageReques
ClearCancelMessageRequestListener()
Description: fire when service receive cancel message request (06)
OnSetRequest AddSetRequestListener(OnSetRequestListener listener)
RemoveSetRequestListener(OnSetRequestListener listener)
ClearSetRequestListener()
Description: fire when service receive set request (08) from client
OnGetRequest AddGetRequestListener(OnGetRequestListener listener)
RemoveGetRequestListener(OnGetRequestListener listener)
ClearGetRequestListener()
Description: fire when service receive get request (09) from client
OnAliveRequest AddAliveRequestListener(OnAliveRequestListener listener)
RemoveAliveRequestListener(OnAliveRequestListener listener)
ClearAliveRequestListener()
Description: fire when service receive alive request (40) from clien
OnDeliverMessageResponse AddDeliverMessageResponseListener(OnDeliverMessageListener
RemoveDeliverMessageResponseListener(OnDeliverMessageListe
ClearDeliverMessageResponseListener()
Description: fire when service receive deliver message response (7
Description: fire when service receive deliver status report respons
Description: fire when service receive NACK response (99) from c
* see more detail in CIMDService.CIMDServer.EventArgs
Class CIMDService.CIMDServer.UserProfile
Class: UserProfile
Public Properties
-
Public Methods
Function Retu

CIMDLib Manual Beta

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

CIMDLib Manual Beta

Transféré par

Droits d'auteur :

Formats disponibles

CIMDLib Manual

Public Business Methods

OnSetRequest AddSetRequestListener(OnSetRequestListener listener)

OnDisconnectingInfo AddDisconnectingInfoListener(OnDisconnectingInfoListener listen

Vous aimerez peut-être aussi