Home > PHP > Function > SAM > SAMConnection->subscribe()

SAMConnection->subscribe()

SAMConnection->subscribe - Create a subscription to a specified topic.

Syntax

string SAMConnection->subscribe (string $targetTopic)

Arguments

  • targetTopic - The identity of the topic (topic://topicname) to subscribe to.

Description

The "subscribe" method is used to create a new subscription to a specified topic.

Version

PHP PECL sam >= 0.1.0

Return value

A subscription identifier that can be used in a subsequent receive call as a selector to obtain any topic data or FALSE if an error occurred. The subscription identifier should be used in the receive call in place of the simple topic name.