API Documentation

Zend/Queue/Stomp/Client/ConnectionInterface.php

Show: inherited
    Table of Contents

    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.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Queue  
    Subpackage
    Stomp  
    Version
    $Id: ConnectionInterface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Queue_Stomp_Client_ConnectionInterface

    Package: Zend\Queue\Stomp

    The Stomp client interacts with a Stomp server.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpubliccanRead( ) : void

    tests the socket to see if there is data for us

    methodpublicclose( boolean $destructor = false ) : void

    Parameters
    Name Type Description
    $destructor boolean
    methodpubliccreateFrame( ) : \Zend_Queue_Stomp_FrameInterface

    create an empty frame

    Returns
    Type Description
    \Zend_Queue_Stomp_FrameInterface class
    methodpublicgetFrameClass( ) : string

    Get the frameClass

    Returns
    Type Description
    string
    methodpublicopen( string $scheme, string $host, integer $port ) : boolean

    Parameters
    Name Type Description
    $scheme string

    ['tcp', 'udp']

    $host string

    host

    $port integer

    port

    Returns
    Type Description
    boolean
    methodpublicping( ) : true

    Check whether we are connected to the server

    Returns
    Type Description
    true
    Throws
    Exception Description
    \Zend_Queue_Exception
    methodpublicread( ) : \Zend_Queue_Stomp_Frame|false

    reads in a frame from the socket or returns false.

    Returns
    Type Description
    \Zend_Queue_Stomp_Frame|false
    Throws
    Exception Description
    \Zend_Queue_Exception
    methodpublicsetFrameClass( string $class ) : \Zend_Queue_Stomp_Client_ConnectionInterface;

    Set the frame class to be used

    This must be a Zend_Queue_Stomp_FrameInterface.

    Parameters
    Name Type Description
    $class string
    Returns
    Type Description
    \Zend_Queue_Stomp_Client_ConnectionInterface;
    methodpublicwrite( \Zend_Queue_Stomp_FrameInterface $frame ) : \Zend_Queue_Stomp_Client_ConnectionInterface

    write a frame to the stomp server

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

    Parameters
    Name Type Description
    $frame \Zend_Queue_Stomp_FrameInterface
    Returns
    Type Description
    \Zend_Queue_Stomp_Client_ConnectionInterface
    Details
    Fluent
    This method is part of a fluent interface and will return the same instance  
    Documentation was generated by DocBlox 0.15.1.