API Documentation

Queue/Stomp/Client/ConnectionInterface.php

Interfaces
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Queue
subpackage
Stomp
version
$Id: ConnectionInterface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Queue_Stomp_Client_ConnectionInterface

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Queue_Stomp_Client_ConnectionInterface
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Queue
subpackage
Stomp
Methods
open
close
ping
write
canRead
read
setFrameClass
getFrameClass
createFrame

Description

The Stomp client interacts with a Stomp server.

Methods

canRead
jump to class

canRead( ) :

tests the socket to see if there is data for us

Details
visibility
public
final
false
static
false

close
jump to class

close( boolean $destructor = false ) : void

Arguments
$destructor
boolean
Details
visibility
public
final
false
static
false

createFrame
jump to class

createFrame( ) : Zend_Queue_Stomp_FrameInterface

create an empty frame

Output
Zend_Queue_Stomp_FrameInterface
class
Details
visibility
public
final
false
static
false

getFrameClass
jump to class

getFrameClass( ) : string

Get the frameClass

Output
string
Details
visibility
public
final
false
static
false

open
jump to class

open( string $scheme, string $host, integer $port ) : boolean

Arguments
$scheme
string
['tcp', 'udp']
$host
string
host
$port
integer
port
Output
boolean
Details
visibility
public
final
false
static
false

ping
jump to class

ping( ) : true

Check whether we are connected to the server

Output
true
Details
visibility
public
final
false
static
false
throws

read
jump to class

read( ) : Zend_Queue_Stomp_Frame|false

reads in a frame from the socket or returns false.

Output
Zend_Queue_Stomp_Frame|false
Details
visibility
public
final
false
static
false
throws

setFrameClass
jump to class

setFrameClass( string $class ) : Zend_Queue_Stomp_Client_ConnectionInterface;

Set the frame class to be used

This must be a Zend_Queue_Stomp_FrameInterface.

Arguments
$class
string
Output
Zend_Queue_Stomp_Client_ConnectionInterface;
Details
visibility
public
final
false
static
false

write
jump to class

write( Zend_Queue_Stomp_FrameInterface $frame ) : $this

write a frame to the stomp server

example: $response = $client->write($frame)->read();

Arguments
$frame
Zend_Queue_Stomp_FrameInterface
Output
$this
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.