Go to the latest version of this document.

# ``twisted`.`protocols`.`amp`.`_TLSBox``

class documentation

`class _TLSBox(AmpBox): (source)`

Constructor: `_TLSBox()`

View In Hierarchy

I am an AmpBox that, upon being sent, initiates a TLS connection.

Method | `__init__` | Initialize a new `AmpBox`.
Class Variable | `__slots__` | Undocumented
Property | `certificate` | Undocumented
Property | `verify` | Undocumented
Method | `_sendTo` | Send my encoded value to the protocol, then initiate TLS.

Inherited from `AmpBox`:

Method | `__repr__` | Undocumented
Method | `copy` | Return another AmpBox just like me.
Method | `serialize` | Convert me into a wire-encoded string.

def __init__(self): (source)
overrides `twisted.protocols.amp.AmpBox.__init__`

Initialize a new `AmpBox`.

In Python 3, keyword arguments MUST be Unicode/native strings whereas in Python 2 they could be either byte strings or Unicode strings.

However, all keys of an `AmpBox` MUST be byte strings, or possible to transparently coerce into byte strings (i.e. Python 2).

In Python 3, therefore, native string keys are coerced to byte strings by encoding as ASCII. This can result in `UnicodeEncodeError` being raised.

Parameters
*args | See `dict`, but all keys and values should be `bytes`. On Python 3, native strings may be used as keys provided they contain only ASCII characters.
**kw | See `dict`, but all keys and values should be `bytes`. On Python 3, native strings may be used as keys provided they contain only ASCII characters.

Raises
`UnicodeEncodeError` | When a native string key cannot be coerced to an ASCII byte string (Python 3 only).

__slots__: `list[str]` = (source)
overrides `twisted.protocols.amp.AmpBox.__slots__`

Undocumented

@property
certificate = (source)

Undocumented

@property
verify = (source)

Undocumented

def _sendTo(self, proto): (source)
overrides `twisted.protocols.amp.AmpBox._sendTo`

Send my encoded value to the protocol, then initiate TLS.