PullPoint
Events (PullPoint) service implementation.
Bases: ONVIFService
Events (PullPoint) service client.
| Property | Details |
|---|---|
| First introduced | ONVIF 1.0 (November 2008) |
| Binding name | PullPointSubscriptionBinding (ver10/events/wsdl/event-vs.wsdl) |
| Operations | event-vs.wsdl |
| Spec | Core |
This method pulls one or more messages from a PullPoint.
The device shall provide the following PullMessages command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. This method shall not wait until the requested number of messages is available but return as soon as at least one message is available.
The command shall at least support a Timeout of one minute. In case a device supports retrieval of less messages than requested it shall return these without generating a fault.
Input
-
Timeout[duration]Maximum time to block until this method returns. -
MessageLimit[int]Upper limit for the number of messages to return at once. A server implementation may decide to return less messages.
Output
-
CurrentTime[dateTime]Current time of the device for synchronization purposes. -
TerminationTime[dateTime]Date time when the PullPoint will be shut down without further pull requests. -
NotificationMessage- optional, unbounded; [NotificationMessageHolderType]List of messages. This list shall be empty in case of a timeout.-
SubscriptionReference- optional; [EndpointReferenceType]-
Address[AttributedURIType] -
ReferenceParameters- optional; [ReferenceParametersType] -
Metadata- optional; [MetadataType]
-
-
Topic- optional; [TopicExpressionType]-
Dialect- required; [anyURI]
-
-
ProducerReference- optional; [EndpointReferenceType]-
Address[AttributedURIType] -
ReferenceParameters- optional; [ReferenceParametersType] -
Metadata- optional; [MetadataType]
-
-
Message[complexType]
-
This method readjusts the pull pointer into the past.
A device supporting persistent notification storage shall provide the following Seek command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. The optional Reverse argument can be used to reverse the pull direction of the PullMessages command.
The UtcTime argument will be matched against the UtcTime attribute on a NotificationMessage.
Input
-
UtcTime[dateTime]The date and time to match against stored messages. -
Reverse- optional; [boolean]Reverse the pull direction of PullMessages.
Properties inform a client about property creation, changes and deletion in a uniform way.
When a client wants to synchronize its properties with the properties of the device, it can request a synchronization point which repeats the current status of all properties to which a client has subscribed. The PropertyOperation of all produced notifications is set to "Initialized". The Synchronization Point is requested directly from the SubscriptionManager which was returned in either the SubscriptionResponse or in the CreatePullPointSubscriptionResponse. The property update is transmitted via the notification transportation of the notification interface. This method is mandatory.