API Documentation

Queue/Stomp/Client/Connection.php

Includes Classes 
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: Connection.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Stomp_Client_Connection

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_Connection
jump to top

Implements
Zend_Queue_Stomp_Client_ConnectionInterface
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
Constants
READ_TIMEOUT_DEFAULT_USEC
READ_TIMEOUT_DEFAULT_SEC
Properties
$_options
$_socket
Methods
open
__destruct
close
ping
write
canRead
read
setFrameClass
getFrameClass
createFrame

Description

The Stomp client interacts with a Stomp server.

Constants

READ_TIMEOUT_DEFAULT_USEC
jump to class

 READ_TIMEOUT_DEFAULT_USEC = '0'

Details

value
0

READ_TIMEOUT_DEFAULT_SEC
jump to class

 READ_TIMEOUT_DEFAULT_SEC = '5'

Details

value
5

Properties

$_options
jump to class

array $_options = ''

Connection options

Details

$_options
array
visibility
protected
default
final
false
static
false

$_socket
jump to class

resource $_socket = 'false'

tcp/udp socket

Details

$_socket
resource
visibility
protected
default
false
final
false
static
false

Methods

__destruct
jump to class

__destruct( ) : void

Close the socket explicitly when destructed

Details
visibility
public
final
false
static
false

canRead
jump to class

canRead( ) : boolean

Tests the socket to see if there is data for us

Output
boolean
Details
visibility
public
final
false
static
false

close
jump to class

close( boolean $destructor = false ) : void

Close connection

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
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, int $port, array|array $options = array ) : true;

open() opens a socket to the Stomp server

Arguments
$scheme
string
$host
string
$port
int
$options
arrayarray
('scheme', 'host', 'port')
Output
true;
Details
visibility
public
final
false
static
false
throws

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_FrameInterface|false

Reads in a frame from the socket or returns false.

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

setFrameClass
jump to class

setFrameClass( string $classname ) : $this;

Set the frameClass to be used

This must be a Zend_Queue_Stomp_FrameInterface.

Arguments
$classname
string
- class is an instance of Zend_Queue_Stomp_FrameInterface
Output
$this;
Details
visibility
public
final
false
static
false

write
jump to class

write( Zend_Queue_Stom_FrameInterface $frame ) : $this

Write a frame to the stomp server

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

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