View Source ExOnvif.PullPoint (ExOnvif v0.7.1)

Interface for making requests to the PullPoint service.

Summary

Functions

This method pulls one or more messages from a PullPoint.

Functions

pull_messages(device, url, opts \\ [])

@spec pull_messages(
  device :: ExOnvif.Device.t(),
  url :: String.t(),
  opts :: Keyword.t()
) :: {:ok, ExOnvif.Event.Messages.t()} | {:error, any()}

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 following options may be provided:

  • timeout - Timeout in seconds. Defaults to: 2
  • message_limit - The max number messages to retrieve from the pull point. Defaults to: 10
  • subscription_id - Subscription id to include as header in the soap request.