API Documentation

Zend/Amf/Value/Messaging/CommandMessage.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_Amf  
Subpackage
Value  
Version
$Id: CommandMessage.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Amf_Value_Messaging_CommandMessage

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

Constant  SUBSCRIBE_OPERATION = 0

This operation is used to subscribe to a remote destination.

Constant  UNSUSBSCRIBE_OPERATION = 1

This operation is used to unsubscribe from a remote destination.

Constant  POLL_OPERATION = 2

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

Constant  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.

Constant  CLIENT_PING_OPERATION = 5

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

Constant  CLUSTER_REQUEST_OPERATION = 7

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

Constant  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.

Constant  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.

Constant  SESSION_INVALIDATE_OPERATION = 10

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

Constant  MULTI_SUBSCRIBE_OPERATION = 11

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

Constant  DISCONNECT_OPERATION = 12

This operation is used to indicate that a channel has disconnected

Constant  UNKNOWN_OPERATION = 10000

This is the default operation for new CommandMessage instances.

Properties

Propertypublicint  $operation= 'self::UNKNOWN_OPERATION'

The operation to execute for messages of this type

Default valueself::UNKNOWN_OPERATIONDetails
Type
int
Documentation was generated by DocBlox 0.15.1.