Kamaelia.Internet.TCPClient.TCPClient

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

---

class TCPClient(Axon.Component.component)

TCPClient(host,port[,delay]) -> component with a TCP connection to a server.

Establishes a TCP connection to the specified server.

Keyword arguments:

• host -- address of the server to connect to (string)
• port -- port number to connect on
• delay -- delay (seconds) after activation before connecting (default=0)

Inboxes

• control : Shutdown signalling
• makessl : Notifications to the ConnectedSocketAdapter that we want to negotiate SSL
• inbox : data to send to the socket
• _socketFeedback : notifications from the ConnectedSocketAdapter

Outboxes

• outbox : data received from the socket
• signal : socket errors
• sslready : SSL negotiated successfully
• _selectorSignal : For registering and deregistering ConnectedSocketAdapter components with a selector service

Methods defined here

__init__(self, host, port[, delay][, connect_timeout])

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

main(self)

Main loop.

runClient(self[, sock])

safeConnect(self, sock, *sockArgsList)

Connect to socket and handle possible errors that may occur.

Returns True if successful, or False on failure. Unhandled errors are raised as exceptions.

setupCSA(self, sock)

setupCSA(sock) -> new ConnectedSocketAdapter component

Creates a ConnectedSocketAdapter component for the socket, and wires up to it. Also sends the CSA to the "selector" service.

shutdown(self)

stop(self)

Stop method provided to allow the scheduler to kill TCPClient connections cleanly if necessary. (Only rarely, if ever, needed - you are not expected to call this yourself)

waitCSAClose(self)

Returns True if a socketShutdown message is received on "_socketFeedback" inbox.

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