QueueMessageFormat Class

  • Reference

Encoding and decoding methods which can be used to modify how the queue service encodes and decodes queue messages. Set these to queueservice.encode_function and queueservice.decode_function to modify the behavior. The defaults are text_xmlencode and text_xmldecode, respectively.

Inheritance
builtins.object
QueueMessageFormat

Constructor

QueueMessageFormat()

Methods

binary_base64decode

Base64 decode to byte string.
binary_base64encode

Base64 encode byte strings.
nodecode

Do no decoding.
noencode

Do no encoding.
text_base64decode

Base64 decode to unicode text.
text_base64encode

Base64 encode unicode text.
text_xmldecode

XML decode to unicode text.
text_xmlencode

XML encode unicode text.

binary_base64decode

Base64 decode to byte string.

static binary_base64decode(data)

Parameters

Name Description
data
Required
str

Data to decode to a byte string.

Returns

Type Description
str

Base64 decoded data.

binary_base64encode

Base64 encode byte strings.

static binary_base64encode(data)

Parameters

Name Description
data
Required
str

Binary string to encode.

Returns

Type Description
str

Base64 encoded data.

nodecode

Do no decoding.

static nodecode(data)

Parameters

Name Description
data
Required
str

Data.

Returns

Type Description
str

The data passed in is returned unmodified.

noencode

Do no encoding.

static noencode(data)

Parameters

Name Description
data
Required
str

Data.

Returns

Type Description
str

The data passed in is returned unmodified.

text_base64decode

Base64 decode to unicode text.

static text_base64decode(data)

Parameters

Name Description
data
Required
str

String data to decode to unicode.

Returns

Type Description
str

Base64 decoded string.

text_base64encode

Base64 encode unicode text.

static text_base64encode(data)

Parameters

Name Description
data
Required
str

String to encode.

Returns

Type Description
str

Base64 encoded string.

text_xmldecode

XML decode to unicode text.

static text_xmldecode(data)

Parameters

Name Description
data
Required
str

Data to decode to unicode.

Returns

Type Description
str

XML decoded data.

text_xmlencode

XML encode unicode text.

static text_xmlencode(data)

Parameters

Name Description
data
Required
str

Unicode string to encode

Returns

Type Description
str

XML encoded data.