Kamaelia.Internet.ConnectedSocketAdapter.ConnectedSocketAdapter

For examples and more explanations, see the module level docs.

---

class ConnectedSocketAdapter(Axon.Component.component)

ConnectedSocketAdapter(socket) -> new CSA component wrapping specified socket

Component for communicating with a socket. Send to its "inbox" inbox to send data, and receive data from its "outbox" outbox.

"ReadReady" inbox must be wired to something that will notify it when new data has arrived at the socket.

Inboxes

• control : Shutdown on producerFinished message (incoming & outgoing data is flushed first)
• ReadReady : Notify this CSA that there is incoming data ready on the socket
• makessl : Notify this CSA that the socket should be wrapped into SSL
• inbox : Data for this CSA to send through the socket (Axon.Ipc.status message)
• SendReady : Notify this CSA that the socket is ready to send

Outboxes

• outbox : Data received from the socket
• CreatorFeedback : Expected to be connected to some form of signal input on the CSA's creator. Signals socketShutdown (this socket has closed)
• sslready : Notifies components that the socket is now wrapped into SSL
• signal : Signals shutdownCSA (this CSA is shutting down)
• _selectorSignal : For communication to the selector

Methods defined here

__init__(self, listensocket, selectorService[, crashOnBadDataToSend][, noisyErrors])

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

_saferecv(self, sock[, size])

Internal only function, used for recieving data, and handling EAGAIN style retry scenarios gracefully

_safesend(self, sock, data)

Internal only function, used for sending data, and handling EAGAIN style retry scenarios gracefully

canDoSomething(self)

checkSocketStatus(self)

flushSendQueue(self)

handleControl(self)

Check for producerFinished message and shutdown in response

handleReceive(self)

main(self)

passOnShutdown(self)

stop(self)

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT