Skip to content

Commit

Permalink
adding MSDN docs to Service Bus
Browse files Browse the repository at this point in the history
  • Loading branch information
unknown authored and unknown committed Sep 1, 2012
1 parent aa2dfd7 commit b77ec82
Show file tree
Hide file tree
Showing 4 changed files with 75 additions and 7 deletions.
2 changes: 1 addition & 1 deletion WindowsAzure/ServiceBus/Models/RuleDescription.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* @copyright 2012 Microsoft Corporation
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @version Release: @package_version@
* @link https://github.com/WindowsAzure/azure-sdk-for-php
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780753
*/

class RuleDescription
Expand Down
2 changes: 1 addition & 1 deletion WindowsAzure/ServiceBus/Models/SubscriptionDescription.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* @copyright 2012 Microsoft Corporation
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @version Release: @package_version@
* @link https://github.com/WindowsAzure/azure-sdk-for-php
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780763
*/

class SubscriptionDescription
Expand Down
2 changes: 1 addition & 1 deletion WindowsAzure/ServiceBus/Models/TopicDescription.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* @copyright 2012 Microsoft Corporation
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @version Release: @package_version@
* @link https://github.com/WindowsAzure/azure-sdk-for-php
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780749
*/
class TopicDescription
{
Expand Down
76 changes: 72 additions & 4 deletions WindowsAzure/ServiceBus/ServiceBusRestProxy.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ public function __construct($channel, $uri, $dataSerializer)
/**
* Sends a brokered message.
*
* Queues:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780775
*
* Topic Subscriptions:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780786
*
* @param type $path The path to send message.
* @param type $brokeredMessage The brokered message.
*
Expand Down Expand Up @@ -136,6 +142,8 @@ public function sendMessage($path, $brokeredMessage)
/**
* Sends a queue message.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780775
*
* @param string $queueName The name of the queue.
* @param BrokeredMessage $brokeredMessage The brokered message.
*
Expand All @@ -149,11 +157,14 @@ public function sendQueueMessage($queueName, $brokeredMessage)

/**
* Receives a queue message.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780735
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780756
*
* @param string $queueName The name of the
* queue.
* @param ReceiveMessageOptions $receiveMessageOptions The options to
* receive the message.
* receive the message.
*
* @return BrokeredMessage
*/
Expand All @@ -169,11 +180,19 @@ public function receiveQueueMessage($queueName, $receiveMessageOptions = null)
/**
* Receives a message.
*
* Queues:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780735
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780756
*
* Topic Subscriptions:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780722
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780770
*
* @param string $path The path of the
* message.
* @param ReceivedMessageOptions $receiveMessageOptions The options to
* receive the message.
*
*
* @return BrokeredMessage
*/
public function receiveMessage($path, $receiveMessageOptions = null)
Expand Down Expand Up @@ -252,6 +271,8 @@ public function receiveMessage($path, $receiveMessageOptions = null)

/**
* Sends a brokered message to a specified topic.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780786
*
* @param string $topicName The name of the topic.
* @param BrokeredMessage $brokeredMessage The brokered message.
Expand All @@ -267,6 +288,9 @@ public function sendTopicMessage($topicName, $brokeredMessage)

/**
* Receives a subscription message.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780722
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780770
*
* @param string $topicName The name of the
* topic.
Expand Down Expand Up @@ -298,6 +322,12 @@ public function receiveSubscriptionMessage(

/**
* Unlocks a brokered message.
*
* Queues:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780723
*
* Topic Subscriptions:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780737
*
* @param BrokeredMessage $brokeredMessage The brokered message.
*
Expand Down Expand Up @@ -327,6 +357,12 @@ public function unlockMessage($brokeredMessage)

/**
* Deletes a brokered message.
*
* Queues:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780767
*
* Topic Subscriptions:
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780768
*
* @param BrokeredMessage $brokeredMessage The brokered message.
*
Expand Down Expand Up @@ -362,6 +398,8 @@ public function deleteMessage($brokeredMessage)
/**
* Creates a queue with a specified queue information.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780716
*
* @param QueueInfo $queueInfo The information of the queue.
*
* @return QueueInfo
Expand Down Expand Up @@ -391,6 +429,8 @@ public function createQueue($queueInfo)

/**
* Deletes a queue.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780747
*
* @param string $queuePath The path of the queue.
*
Expand All @@ -411,6 +451,8 @@ public function deleteQueue($queuePath)

/**
* Gets a queue with specified path.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780764
*
* @param string $queuePath The path of the queue.
*
Expand All @@ -430,6 +472,8 @@ public function getQueue($queuePath)

/**
* Lists a queue.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780759
*
* @param ListQueuesOptions $listQueuesOptions The options to list the
* queues.
Expand Down Expand Up @@ -482,6 +526,8 @@ private function _listOptions($listOptions, $path)

/**
* Creates a topic with specified topic info.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780728
*
* @param TopicInfo $topicInfo The information of the topic.
*
Expand Down Expand Up @@ -526,7 +572,9 @@ public function createTopic($topicInfo)
}

/**
* Deletes a topic with specified topic path.
* Deletes a topic with specified topic path.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780721
*
* @param string $topicPath The path of the topic.
*
Expand All @@ -543,7 +591,9 @@ public function deleteTopic($topicPath)
}

/**
* Gets a topic.
* Gets a topic.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780769
*
* @param string $topicPath The path of the topic.
*
Expand All @@ -563,6 +613,8 @@ public function getTopic($topicPath)

/**
* Lists topics.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780744
*
* @param ListTopicsOptions $listTopicsOptions The options to list
* the topics.
Expand All @@ -584,6 +636,8 @@ public function listTopics($listTopicsOptions = null)
/**
* Creates a subscription with specified topic path and
* subscription info.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780748
*
* @param string $topicPath The path of
* the topic.
Expand Down Expand Up @@ -636,6 +690,8 @@ public function createSubscription($topicPath, $subscriptionInfo)

/**
* Deletes a subscription.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780740
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand All @@ -658,6 +714,8 @@ public function deleteSubscription($topicPath, $subscriptionName)

/**
* Gets a subscription.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780741
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand All @@ -683,6 +741,8 @@ public function getSubscription($topicPath, $subscriptionName)

/**
* Lists subscription.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780766
*
* @param string $topicPath The path of
* the topic.
Expand Down Expand Up @@ -711,6 +771,8 @@ public function listSubscriptions(

/**
* Creates a rule.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780774
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand Down Expand Up @@ -763,6 +825,8 @@ public function createRule($topicPath, $subscriptionName, $ruleInfo)

/**
* Deletes a rule.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780751
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand All @@ -787,6 +851,8 @@ public function deleteRule($topicPath, $subscriptionName, $ruleName)

/**
* Gets a rule.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780772
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand Down Expand Up @@ -814,6 +880,8 @@ public function getRule($topicPath, $subscriptionName, $ruleName)

/**
* Lists rules.
*
* @link http://msdn.microsoft.com/en-us/library/windowsazure/hh780732
*
* @param string $topicPath The path of the topic.
* @param string $subscriptionName The name of the subscription.
Expand Down

0 comments on commit b77ec82

Please sign in to comment.