twisted.protocols.sip.Proxy : API documentation

class documentation

class twisted.protocols.sip.Proxy(Base): (source)

Known subclasses: twisted.protocols.sip.RegisterProxy

View In Hierarchy

SIP proxy.

Class Variable	locator	Undocumented
Method	__init__	Create new instance.
Instance Variable	host	Undocumented
Instance Variable	port	Undocumented
Method	getVia	Return value of Via header for this proxy.
Method	handle_request	Override to define behavior for requests received
Method	handle_request_default	Default request handler.
Method	deliverResponse	Deliver response.
Method	responseFromRequest	Create a response to a request message.
Method	handle_response	Default response handler.
Method	gotResponse	Called with responses that are addressed at this server.
Method	_cantForwardRequest	Undocumented

Inherited from Base:

Class Variable	debug	Undocumented
Instance Variable	messages	Undocumented
Instance Variable	parser	Undocumented
Method	addMessage	Undocumented
Method	datagramReceived	Called when a datagram is received.
Method	sendMessage	Send a message.
Method	_fixupNAT	Undocumented

Inherited from DatagramProtocol (via Base):

Instance Variable	transport	The transport with which this protocol is associated, if it is associated with one.
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method	connectionRefused	Called due to error from write in connected mode.

Inherited from AbstractDatagramProtocol (via Base, DatagramProtocol):

Instance Variable	numPorts	Undocumented
Class Variable	noisy	Undocumented
Method	__getstate__	Undocumented
Method	doStart	Make sure startProtocol is called.
Method	doStop	Make sure stopProtocol is called.
Method	startProtocol	Called when a transport is connected to this protocol.
Method	stopProtocol	Called when the transport is disconnected.
Method	makeConnection	Make a connection to a transport and a server.

locator = (source)

Undocumented

def __init__(self, host=None, port=PORT): (source)

overrides twisted.protocols.sip.Base.__init__

overridden in twisted.protocols.sip.RegisterProxy

Create new instance.

Parameters	host	our hostname/IP as set in Via headers.
	port	our port as set in Via headers.

host = (source)

Undocumented

port = (source)

Undocumented

def getVia(self): (source)

Return value of Via header for this proxy.

def handle_request(self, message, addr): (source)

overrides twisted.protocols.sip.Base.handle_request

Override to define behavior for requests received

Parameters	message	Undocumented (type: `Message`)
	addr	Undocumented (type: `tuple`)

def handle_request_default(self, message, sourcePeer): (source)

Default request handler.

Default behaviour for OPTIONS and unknown methods for proxies is to forward message on to the client.

Since at the moment we are stateless proxy, that's basically everything.

def _cantForwardRequest(self, error, message): (source)

Undocumented

def deliverResponse(self, responseMessage): (source)

overrides twisted.protocols.sip.Base.deliverResponse

Deliver response.

Destination is based on topmost Via header.

def responseFromRequest(self, code, request): (source)

overrides twisted.protocols.sip.Base.responseFromRequest

Create a response to a request message.

def handle_response(self, message, addr): (source)

overrides twisted.protocols.sip.Base.handle_response

Default response handler.

def gotResponse(self, message, addr): (source)

Called with responses that are addressed at this server.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.