Amf/Value/Messaging/CommandMessage.php

Show:

inherited

Classes
- \Zend_Amf_Value_Messaging_CommandMessage

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_Amf
Subpackage: Value
Version: $Id: CommandMessage.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Amf_Value_Messaging_CommandMessage
jump to top

Package: Zend\Amf\Value

A message that represents an infrastructure command passed between client and server.

Subscribe/unsubscribe operations result in CommandMessage transmissions, as do polling operations.

Corresponds to flex.messaging.messages.CommandMessage

Note: THESE VALUES MUST BE THE SAME ON CLIENT AND SERVER

Parent(s): \Zend_Amf_Value_Messaging_AsyncMessage < \Zend_Amf_Value_Messaging_AbstractMessage
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                SUBSCRIBE_OPERATION
                = 0

This operation is used to subscribe to a remote destination.

 
                UNSUSBSCRIBE_OPERATION
                = 1

This operation is used to unsubscribe from a remote destination.

 
                POLL_OPERATION
                = 2

This operation is used to poll a remote destination for pending, undelivered messages.

 
                CLIENT_SYNC_OPERATION
                = 4

This operation is used by a remote destination to sync missed or cached messages back to a client as a result of a client issued poll command.

 
                CLIENT_PING_OPERATION
                = 5

This operation is used to test connectivity over the current channel to the remote endpoint.

 
                CLUSTER_REQUEST_OPERATION
                = 7

This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.

 
                LOGIN_OPERATION
                = 8

This operation is used to send credentials to the endpoint so that the user can be logged in over the current channel.

The credentials need to be Base64 encoded and stored in the

body

of the message.

 
                LOGOUT_OPERATION
                = 9

This operation is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.

 
                SESSION_INVALIDATE_OPERATION
                = 10

This operation is used to indicate that the client's subscription to a remote destination has been invalidated.

 
                MULTI_SUBSCRIBE_OPERATION
                = 11

This operation is used by the MultiTopicConsumer to subscribe/unsubscribe from multiple subtopics/selectors in the same message.

 
                DISCONNECT_OPERATION
                = 12

This operation is used to indicate that a channel has disconnected

 
                UNKNOWN_OPERATION
                = 10000

This is the default operation for new CommandMessage instances.

Properties

string $body

inherited

Message body

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$body \Zend_Amf_Value_Messaging_AsyncMessage::$$body

Details

Type: string
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$body
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$body

string $clientId

inherited

Client identifier

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$clientId \Zend_Amf_Value_Messaging_AsyncMessage::$$clientId

Details

Type: string
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$clientId
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$clientId

String $correlationId

inherited

The message id to be responded to.

Inherited from: \Zend_Amf_Value_Messaging_AsyncMessage::$$correlationId

Details

Type: String
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$correlationId

string $destination

inherited

Destination

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$destination \Zend_Amf_Value_Messaging_AsyncMessage::$$destination

Details

Type: string
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$destination
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$destination

object $headers

inherited

Message headers

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$headers \Zend_Amf_Value_Messaging_AsyncMessage::$$headers

Details

Type: object
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$headers
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$headers

string $messageId

inherited

Message identifier

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$messageId \Zend_Amf_Value_Messaging_AsyncMessage::$$messageId

Details

Type: string
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$messageId
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$messageId

int $operation = self::UNKNOWN_OPERATION

The operation to execute for messages of this type

Default valueself::UNKNOWN_OPERATIONDetails

Type: int

int $timeToLive

inherited

Message TTL

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$timeToLive \Zend_Amf_Value_Messaging_AsyncMessage::$$timeToLive

Details

Type: int
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$timeToLive
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$timeToLive

int $timestamp

inherited

Message timestamp

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::$$timestamp \Zend_Amf_Value_Messaging_AsyncMessage::$$timestamp

Details

Type: int
Inherited_from: \Zend_Amf_Value_Messaging_AbstractMessage::$$timestamp
Inherited_from: \Zend_Amf_Value_Messaging_AsyncMessage::$$timestamp

Methods

generateId() : string

inherited

generate a unique id

Inherited from: \Zend_Amf_Value_Messaging_AbstractMessage::generateId()\Zend_Amf_Value_Messaging_AsyncMessage::generateId()

Format is: ########-####-####-####-############ Where # is an uppercase letter or number example: 6D9DC7EC-A273-83A9-ABE3-00005FD752D6

Returns

Type	Description
string

Amf/Value/Messaging/CommandMessage.php

\Zend_Amf_Value_Messaging_CommandMessagejump to top

Constants

Properties

Methods

\Zend_Amf_Value_Messaging_CommandMessage
jump to top