API Documentation

Amf/Value/Messaging/CommandMessage.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_Amf
subpackage
Value
version
$Id: CommandMessage.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Amf_Value_Messaging_CommandMessage

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_Amf_Value_Messaging_CommandMessage

Extends from
Zend_Amf_Value_Messaging_AsyncMessage
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_Amf
subpackage
Value
Constants
SUBSCRIBE_OPERATION
UNSUSBSCRIBE_OPERATION
POLL_OPERATION
CLIENT_SYNC_OPERATION
CLIENT_PING_OPERATION
CLUSTER_REQUEST_OPERATION
LOGIN_OPERATION
LOGOUT_OPERATION
SESSION_INVALIDATE_OPERATION
MULTI_SUBSCRIBE_OPERATION
DISCONNECT_OPERATION
UNKNOWN_OPERATION
Properties
$operation

Description

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

Constants

SUBSCRIBE_OPERATION

 SUBSCRIBE_OPERATION = '0'

This operation is used to subscribe to a remote destination.

Details

value
0

UNSUSBSCRIBE_OPERATION

 UNSUSBSCRIBE_OPERATION = '1'

This operation is used to unsubscribe from a remote destination.

Details

value
1

POLL_OPERATION

 POLL_OPERATION = '2'

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

Details

value
2

CLIENT_SYNC_OPERATION

 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.

Details

value
4

CLIENT_PING_OPERATION

 CLIENT_PING_OPERATION = '5'

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

Details

value
5

CLUSTER_REQUEST_OPERATION

 CLUSTER_REQUEST_OPERATION = '7'

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

Details

value
7

LOGIN_OPERATION

 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.

Details

value
8

LOGOUT_OPERATION

 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.

Details

value
9

SESSION_INVALIDATE_OPERATION

 SESSION_INVALIDATE_OPERATION = '10'

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

Details

value
10

MULTI_SUBSCRIBE_OPERATION

 MULTI_SUBSCRIBE_OPERATION = '11'

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

Details

value
11

DISCONNECT_OPERATION

 DISCONNECT_OPERATION = '12'

This operation is used to indicate that a channel has disconnected

Details

value
12

UNKNOWN_OPERATION

 UNKNOWN_OPERATION = '10000'

This is the default operation for new CommandMessage instances.

Details

value
10000

Properties

$operation

int $operation = 'self'

The operation to execute for messages of this type

Details

$operation
int
visibility
public
default
self
final
false
static
false
Documentation was generated by DocBlox.