Poll method

Polls the server, prompting a Notifier to check a cache for push requests.

Syntax

return_code Poll(
    const char * Notifier,
    const char * key,
    char * subject = 0,
    size_t * subjectSize = 0,
    char * content = 0,
    size_t * contentSize = 0
) = 0;

Parameters

Notifier The name of the Notifier.
key The name of the poll key identifying the Listener.
subject The buffer to receive a message subject. (null-terminated)
subjectSize IN: The size of the subject buffer.
OUT: The size of the received subject, including a null-terminator, where zero indicates a null subject.
content The buffer to receive message content. (null-terminated)
contentSize IN: The size of the content buffer.
OUT: The size of the received content, including a null-terminator, where zero indicates null content.

Returns

One of the codes listed in the return_code enumeration. See return_code enumeration.

Remarks

The Listener connects to the Notifier, then disconnects after the Notifier checks its cache for a push notification targeted for the given poll key.

Discuss this page in DocCommentXchange.
Send feedback about this page using email.