Grass Valley iControl Services Gateway User Manual

Page 14

Advertising
background image

Page 14 of 26

E

STABLISHING A

S

ERVICE

N

ODE

S

ESSION

T

HROUGH I

C

ONTROL

G

ATEWAY

Once an application has obtained the list of nodes registered to an iControl™Gateway, the application
shall establish a TCP/IP-

XML session with the iControl™ Services Gateway.

The application shall open a TCP/IP socket on the port 13000 of the

iControl™ Services Gateway.

The application can then send any of the following XML commands to the iControl™ Services Gateway:

openID

getParameterInfo

get[ParameterName]

set[ParameterName]

closeID

1.1.13 O

PENING A

S

ESSION

W

ITH A

S

ERVICE

N

ODE

(

OPEN

ID)


Purpose:
Open a session with a Miranda Service Node over an iControl™ Services Gateway (TCP/IP socket port
13000 of iControl™ Services Gateway).

Pre-Requisites:

Short Identifier of the Node Service is known.

IP address of the Service Node is known.

TCP/IP socket port 13000 has been successfully opened at

<address>

of Service Node.


XML Syntax:

<openID>[Service Node Short Identifier]</openID>


Replies:

{…}<ack/

>

{…}<nack/>

The <nack/> reply is returned when:

-

An openID command was already sent and accepted before.

-

The Service Node Short Identifier is wrong or the service is not anymore registered in
Directory services.

{…}<nack exception="please open the id before"/>

After connection to port 13000, the first command to send is openID.

This reply is returned when another command was sent before the openID command or a syntax
error in XML command tags was detected.

{…}<nak/> (in all iControl versions before 3.00)

Is send when [Service Node Identifier] is not a valid service ID (not found in the list of IDs). In this
case, the Gateway closes the connection on port 13000.

Advertising