Kamaelia.Internet.TCPClient.TCPClient

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 : NOT USED
inbox : data to send to the socket
_socketFeedback : notifications from the ConnectedSocketAdapter

Outboxes

outbox : data received from the socket
signal : socket errors
_selectorSignal : communicating with a selectorComponent

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

init(self, host, port, delay)

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

main(self)

Main loop.

runClient(self, sock)

safeConnect(self, sock)

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.

waitCSAClose(self)

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

Feedback

Got a problem with the documentation? Something unclear, could be clearer? Want to help with improving? Constructive criticism, preferably in the form of suggested rewording is very welcome.

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

(C) 2006 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved, This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC.