Data retrieval in subscription mode – 2N Helios IP HTTP API Manual v2.8 User Manual
Page 9
9
In the
mode,
sends events to the subscriber in the form
Subscription
2N
Helios IP
®
of Notify messages.
In the
mode, the client sends the GetMessages request to retrieve the log
PullPoint
data.
Data Retrieval in Subscription Mode
To retrieve events from
in the Subscription mode, subscribe via the
2N Helios IP
®
command, specifying the type of events to be retrieved, the HTTP sending
Subscribe
address and the subscription time.
If the subscription is successful,
sends the
includi
2N Helios IP
®
SubscribeResponse
ng the Subscription Id for subsequent communication with
.
2N Helios IP
®
Now
starts sending
messages to the specified HTTP address.
2N Helios IP
®
Notify
Events are sent at the moment of rise without delay. In your Subscribe request, you
can specify the maximum count of events to be sent within one Notify message.
The subscription time is limited (as specified in the Subscribe request). When the
subscription time expires, you will be unsubscribed automatically. To extend the
subscription time, send the
request before expiry.
will reply
Renew
2N Helios IP
®
with the
message.
RenewResponse
Send the
request to unsubscribe explicitly.
will reply with
Unsubscribe
2N Helios IP
®
the
message.
UnsubscribeResponse
If there is a firewall or NAT between you and
, the Subscription mode
2N Helios IP
®
may not be convenient. The Notify messages are delivered only if the network
elements are properly configured.
The figure below shows the status diagram and typical client -
message
2N Helios IP
®
sequence.