Package pyamf :: Package flex :: Module messaging :: Class ErrorMessage

[hide private]
[frames] | no frames]

# Class ErrorMessage

source code

I am the Flex error message to be returned to the client.

This class is used to report errors within the messaging system.

See Also: ErrorMessage 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

getSmallMessage(self) Return a ISmallMessage representation of this error message. | source code

Inherited from `AcknowledgeMessage`: `__readamf__`, `__writeamf__` Inherited from `AbstractMessage`: `__repr__`, `decodeSmallAttribute`, `encodeSmallAttribute` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__setattr__`, `__str__`

Class Variables | [hide private]

| MESSAGE_DELIVERY_IN_DOUBT = ``'``Client.Error.DeliveryInDoubt``'`` If a message may not have been delivered, the faultCode will contain this constant.
| RETRYABLE_HINT_HEADER = ``'``DSRetryableErrorHint``'`` Header name for the retryable hint header.
Inherited from `AcknowledgeMessage`: `ERROR_HINT_HEADER` 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]

| extendedData Extended data that the remote destination has chosen to associate with this error to facilitate custom error processing on the client.
| faultCode Fault code for the error.
| faultDetail Detailed description of what caused the error.
| faultString A simple description of the error.
| rootCause Should a traceback exist for the error, this property contains the message.
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)

### getSmallMessage(self)

source code

Return a ISmallMessage representation of this error message.

Overrides: AbstractMessage.getSmallMessage

Since: 0.5

Class Variable Details | [hide private]

### RETRYABLE_HINT_HEADER

Header name for the retryable hint header.

This is used to indicate that the operation that generated the error may be retryable rather than fatal.

Value:

      'DSRetryableErrorHint'