Kamaelia docs : 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)


  • 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


  • 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


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][, connect_timeout])

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


Main loop.

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.


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)


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


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

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

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. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved.

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)