This chapter describes how to develop a client to receive X-PUSH messages (nexacro Platform 17.1 Application). X-PUSH client can be configured with the nexacro application. Therefore, in order to develop an X-PUSH client, knowledge of nexacro application development is required.

This document does not describe nexacro application development but only specifics related to the X-PUSH server. For detailed information related to application development, please refer to the nexacro Platform Manual.

nexacro17.1 Client Development

X-PUSH client can be developed with nexacro application. Basically, to receive messages through the X-PUSH server, the X-PUSH protocol adapter must be added and it can be configured through an object.

X-PUSH Protocol Adapter

In nexacro Platform, an X-PUSH protocol adapter is included in the basic package.

Adding X-PUSH Object to nexacro Project

Follow the steps below to add the X-Push object to the project.

1. Select "TypeDefinition"-"Objects" in the Project Explorer window, click the right mouse button, and select "Edit".

2. Press the + button to select the Push.json file and click Open.

3. Select the + button in Objects to select nexacro.XPush and click OK.

4. Check whether the added X-PUSH object is properly registered.

Protocol Adapter Attributes

The following attribute values can be changed.

Protocol Adapter Event Attributes

Events generated from the xpush adapter can be defined.

Examples

Functional Example Application

Location: %XPUSH_HOME%/sample/nexacro_client

The project file of the example application is
%XPUSH_HOME%\sample\nexacro_client\xpushSample.xadl. Open this file in nexacro Studio.

1. Click [File > Open > Project] in the nexacro Studio menu.

2. Select the example project, xpushSample.xprj file.

3. Double-click sample01_functional under Base in the Project Explorer window.

The functions and codes used in the example are described below.

set_projectid, set_protocolversion

Set the project_id information.

this.XPush00.set_projectid("PRO#1");

Set the protocol version to communicate with x-push.

this.XPush00.set_protocolversion('3');

connection

Connect with X-PUSH server.

{
	var value = this.IpPort.value;
	this.XPush00.set_iplist(value);

	this.XPush00.connect("user00","pw");
}

subscribe

Register Topic Type and Topic Id on X-PUSH server.

{
var ret = this.XPush00.subscribe(this.topicTYPE.value, this.topicID.value, this, this.dsMessage, "append", "fn_PushCallback_Test_Data");
}

/*
 * Callback function (Receiving message)
 */
this.fn_PushCallback_Test_Data = function (Row, ChangeColumn, AllColumns, Type, ActionType, MessageId) 
{
	trace("fn_PushCallback - NOTI\n" +
		" - ActionType : " + ActionType + "\n" +
		" - Row : " + Row + "\n" +
		" - MessageId : " + MessageId + "\n" );

	trace(this.dsMessage.saveXML() );

	/*
	 * Receiving a generic message
	 */
	if (ActionType == "PUSH") {
		trace(this.dsMessage.getColumn(0, "NOTI_00"));
		trace(this.dsMessage.getColumn(0, "NOTI_01"));
		trace(this.dsMessage.getColumn(Row, "NOTI_02"));
		trace(this.dsMessage.getColumn(Row, "NOTI_03"));
	}
	
	/*
	 * Receiving a reliable message
	 */
	if (ActionType == "RELI") {
		trace(this.dsMessage.getColumn(0, "NOTI_00"));
		trace(this.dsMessage.getColumn(0, "NOTI_01"));
		trace(this.dsMessage.getColumn(0, "NOTI_22"));
	}
}

Inquiring the Number of Unreceived Messages

Request the number of unreceived messages from the X-PUSH server.

this.btnReqd_onclick = function(obj:Button,  e:nexacro.ClickEventInfo)
{
	this.XPush00.requestMessageCount("NOTI", "ALL");
}

Requesting the Unreceived Messages

Request the unreceived messages from the X-PUSH server.

this.btnReqd_onclick = function(obj:Button,  e:nexacro.ClickEventInfo)
{
	this.XPush00.requestMessage("NOTI", "ALL");
}

Sending Receipt Confirmed Messages

Send a receipt confirmed message to X-PUSH when a reliable message is received from the X-PUSH server.

this.fn_PushCallback_Test_Data = function(Row, ChangeColumn, AllColumn, Type, ActionType, MessageId)
{
	AddLog("get push data. reliable message = " + "[ActionType:" + ActionType + "] " + this.dsMessage.getColumn(0, "Title"));
	
	if (ActionType == "RELI") {
		alert(this.dsMessage.getColumn(0, "Title"));
		this.XPush00.sendResponse(MessageId);
	}
}

User Registration

Add user information (T_TOPIC Table) to the database. User registration (ADUI) must take place after authentication (AUTH).

this.XPush00.registerTopic("NOTI", "ALL");

User Deletion

Delete user information (T_TOPIC Table) from the database.

this.XPush00.unregisterTopic("NOTI", "ALL");

Success/Failure Event Processing

onerror

this.XPush00_onerror = function(obj:XPush,  e:XPushErrorEventInfo)

{
	this.fn_setMsg("XPush00_onerror Event\n" + 
		" - eventid: " + e.eventid + "\n" +
		" - action: " + e.action + "\n" + 
		" - statuscode: " + e.statuscode + "\n" +
		" - errormsg: " + e.errormsg + "\n" +
		" - serverip: " + e.serverip + "\n" +
		" - serverport: " + e.serverport + "\n" +
		" - e.message: " + e.message + "\n" +
		" - e.command : " + e.command );

	if (e.command != null)
	{
		this.fn_setMsg("e.command != null\n" +
			" - e.command.check : " + e.command.check + "\n" +
			" - e.command.row : " + e.command.row + "\n" +
			" - e.command.type : " + e.command.type + "\n" +
		   " - e.command.useactiveformcallback : " + e.command.useactiveformcallback + "\n" +
			" - e.command.actiontype : " + e.command.actiontype + "\n" +
			" - e.command.callback : " + e.command.callback + "\n" +
			" - e.command.messagekey : " + e.command.messagekey + "\n" +
			" - e.command.messagetype : " + e.command.messagetype + "\n" +
			" - e.command.objdataset : " + e.command.objdataset + "\n" +
			" - e.command.objform : " + e.command.objform);	

	}
		
	if (e.message != null)
	{
		this.fn_setMsg("e.message != null\n" +
			" - e.message.messagetype: " + e.message.messagetype + "\n" +
			" - e.message.messagekey: " + e.message.messagekey + "\n" +
			" - e.message.messageid: " + e.message.messageid + "\n" +
			" - e.message.devicetoken: " + e.message.devicetoken);
	}
	
	this.fn_setMsg("e.returnvalue : " + e.returnvalue);
}

onsuccess

this.XPush00_onsuccess = function(obj:XPush,  e:XPushEventInfo)
{
alert("XPush00_onsuccess Event\n" + 
		" - eventid: " + e.eventid + "\n" +
		" - statuscode: " + e.statuscode + "\n" +
		" - errormsg: " + e.errormsg + "\n" +
		" - reason: " + e.reason + "\n" +
		" - action: " + e.action + "\n" +
		" - serverip: " + e.serverip + "\n" +
		" - serverport: " + e.serverport + "\n" +
		" - e.message: " + e.message + "\n" +
		" - e.command : " + e.command + "\n" +
		" - e.returnvalue : " + e.returnvalue);
	if (e.command != null)
	{
		alert("e.command != null\n" +
			" - e.command.check : " + e.command.check + "\n" +
			" - e.command.row : " + e.command.row + "\n" +
			" - e.command.type : " + e.command.type + "\n" +
			" - e.command.useactiveformcallback : " + e.command.useactiveformcallback + "\n" +
			" - e.command.actiontype : " + e.command.actiontype + "\n" +
			" - e.command.callback : " + e.command.callback + "\n" +
			" - e.command.messagekey : " + e.command.messagekey + "\n" +
			" - e.command.messagetype : " + e.command.messagetype + "\n" +
			" - e.command.objdataset : " + e.command.objdataset + "\n" +
			" - e.command.objform : " + e.command.objform);	

	}
		
	if (e.message != null)
	{
		alert("e.message != null\n" +
			" - e.message.messagetype: " + e.message.messagetype + "\n" +
			" - e.message.messagekey: " + e.message.messagekey + "\n" +
			" - e.message.messageid: " + e.message.messageid + "\n" +
			" - e.message.returnvalue: " + e.message.returnvalue + "\n" +
			" - e.message.devicetoken: " + e.message.devicetoken);
			
		if(e.message.returnvalue != undefined || e.message.returnvalue != null) {
			var returnvalue = e.message.returnvalue;
			
			for(var i = 0; i < returnvalue.length; i++) {
				alert("index:" + i + " : " + returnvalue[i].topictype + " : " + returnvalue[i].topicid + " : " + returnvalue[i].count);
			}
		}
	}
}