class documentation
class HAProxyProtocolWrapper(policies.ProtocolWrapper): (source)
Constructor: HAProxyProtocolWrapper(factory, wrappedProtocol)
A Protocol wrapper that provides HAProxy support.
This protocol reads the PROXY stream header, v1 or v2, parses the provided connection data, and modifies the behavior of getPeer and getHost to return the data provided by the PROXY header.
Method | __init__ |
Undocumented |
Method | data |
Called whenever data is received. |
Method | get |
Undocumented |
Method | get |
Undocumented |
Instance Variable | _parser |
Undocumented |
Instance Variable | _proxy |
Undocumented |
Inherited from ProtocolWrapper
:
Method | __getattr__ |
Undocumented |
Method | connection |
Called when the connection is shut down. |
Method | log |
Use a customized log prefix mentioning both the wrapped protocol and the current one. |
Method | lose |
Undocumented |
Method | make |
When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this ProtocolWrapper to intercept any transport calls it makes. |
Method | register |
Undocumented |
Method | stop |
Undocumented |
Method | unregister |
Undocumented |
Method | write |
Undocumented |
Method | write |
Undocumented |
Instance Variable | disconnecting |
Undocumented |
Instance Variable | factory |
The WrappingFactory which created this ProtocolWrapper . |
Instance Variable | wrapped |
An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied. |
Inherited from BaseProtocol
(via ProtocolWrapper
, Protocol
):
Method | connection |
Called when a connection is made. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
def __init__(self, factory:
policies.WrappingFactory
, wrappedProtocol: interfaces.IProtocol
):
(source)
¶
Undocumented
Called whenever data is received.
Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parameters | |
data:bytes | a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time. |