Permalink
Browse files

Add a LICENSE file, update the readme and fix docs in main php file

  • Loading branch information...
1 parent 8800c55 commit 8c54285b12b015049136739cfb0e3d55e2072517 Gavin M. Roy committed Feb 25, 2011
Showing with 35 additions and 9 deletions.
  1. +25 −0 LICENSE
  2. +7 −7 README.md
  3. +3 −2 vorpalbunny.php
View
25 LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2011, Insider Guides, Inc
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+ * Neither the name of the Insider Guides, Inc. nor the names of its
+ contributors may be used to endorse or promote products derived from this
+ software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -1,12 +1,12 @@
-VorpalBunny
+Vorpal Bunny
===========
-VorpalBunny is a publishing client for RabbitMQ's JSON-RPC Channel Plugin
+Vorpal Bunny is a publishing client for RabbitMQ's JSON-RPC Channel Plugin
The goal is to be a light-weight tool for higher throughput with smaller
protocol overhead for calling Basic.Publish from PHP applications.
-VorpalBunny uses PHP with CURL and APC to reduce the traffic footprint for
+Vorpal Bunny uses PHP with CURL and APC to reduce the traffic footprint for
clients who do nothing but publishing. The workflow is to allow the client
to grab a session off of the RabbitMQ JSON-RPC Channel plugin web server
and reuse that session until it is no longer valid. This is accomplished by
@@ -17,9 +17,9 @@ Your exchange and routing key *MUST* be setup prior to use.
Requirements
------------
-PHP 5
-w/ CURL
-APC use is optional but recommended
+* PHP 5
+* w/ CURL
+* APC use is optional but recommended
Example Usage
-------------
@@ -29,4 +29,4 @@ Example Usage
License
-------
-VorpalBunny is released under the BSD License
+VorpalBunny is released under the BSD License
View
@@ -1,6 +1,6 @@
<?php
/**
- * VorpalBunny is a publishing client for RabbitMQ's JSON-RPC Channel Plugin
+ * Vorpal Bunny is a publishing client for RabbitMQ's JSON-RPC Channel Plugin
*
* The goal is to be a light-weight tool for higher throughput with smaller
* protocol overhead for calling Basic.Publish from PHP applications.
@@ -38,6 +38,7 @@ class VorpalBunny
* @param string $user Username to pass to RabbitMQ when starting a session
* @param string $pass Password to send to RabbitMQ when starting a session
* @param string $vhost RabbitMQ VHost to use
+ * @param int $timeout Timeout to set on the RabbitMQ JSONRPC Channel side
*/
function __construct( $host, $port = 55672, $user = 'guest', $pass = 'guest', $vhost = '/', $timeout = 30 )
{
@@ -76,7 +77,7 @@ function __construct( $host, $port = 55672, $user = 'guest', $pass = 'guest', $v
* Construct the JSON data payload for the POST
*
* @param string $method The RPC call to make, one of open, call, cast, poll
- * @param
+ * @param array $params Array of parameters to append to the payload
*/
private function getPayload( $method, $params = array( ) )
{

0 comments on commit 8c54285

Please sign in to comment.