Package pyamf :: Package flex :: Module messaging :: Class CommandMessage
[hide private]
[frames] | no frames]

Class CommandMessage

source code


Provides a mechanism for sending commands related to publish/subscribe messaging, ping, and cluster operations.


See Also: CommandMessage on Livedocs (external)

Nested Classes [hide private]
  __amf__
Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__readamf__(self, input) source code
 
__writeamf__(self, output) source code
 
getSmallMessage(self)
Return a ISmallMessage representation of this command message.
source code

Inherited from AbstractMessage: __repr__, decodeSmallAttribute, encodeSmallAttribute

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Class Variables [hide private]
  AUTHENTICATION_MESSAGE_REF_TYPE = 'flex.messaging.messages.Aut...
The server message type for authentication commands.
  PING_OPERATION = 5
This is used to test connectivity over the current channel to the remote endpoint.
  SYNC_OPERATION = 4
This 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.
  CLUSTER_REQUEST_OPERATION = 7
This is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.
  LOGIN_OPERATION = 8
This is used to send credentials to the endpoint so that the user can be logged in over the current channel.
  LOGOUT_OPERATION = 9
This is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.
  POLL_OPERATION = 2
This is used to poll a remote destination for pending, undelivered messages.
  SELECTOR_HEADER = 'DSSelector'
Subscribe commands issued by a consumer pass the consumer's selector expression in this header.
  SESSION_INVALIDATE_OPERATION = 10
This is used to indicate that the client's session with a remote destination has timed out.
  SUBSCRIBE_OPERATION = 0
This is used to subscribe to a remote destination.
  UNKNOWN_OPERATION = 1000
This is the default operation for new CommandMessage instances.
  UNSUBSCRIBE_OPERATION = 1
This is used to unsubscribe from a remote destination.
  DISCONNECT_OPERATION = 12
This operation is used to indicate that a channel has disconnected.

Inherited from AsyncMessage: SUBTOPIC_HEADER

Inherited from AbstractMessage: DESTINATION_CLIENT_ID_HEADER, ENDPOINT_HEADER, REMOTE_CREDENTIALS_HEADER, REQUEST_TIMEOUT_HEADER, SMALL_ATTRIBUTES, SMALL_ATTRIBUTE_FLAGS, SMALL_UUIDS, SMALL_UUID_FLAGS

Instance Variables [hide private]
str messageRefType
hmm, not sure about this one.
int operation
The command

Inherited from AsyncMessage: correlationId

Inherited from AbstractMessage: body, clientId, destination, headers, messageId, timeToLive, timestamp

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

__readamf__(self, input)

source code 
Overrides: AbstractMessage.__readamf__

__writeamf__(self, output)

source code 
Overrides: AbstractMessage.__writeamf__

getSmallMessage(self)

source code 

Return a ISmallMessage representation of this command message.

Overrides: AbstractMessage.getSmallMessage

Since: 0.5


Class Variable Details [hide private]

AUTHENTICATION_MESSAGE_REF_TYPE

The server message type for authentication commands.

Value:
'flex.messaging.messages.AuthenticationMessage'

LOGIN_OPERATION

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

Value:
8