Server.Server Class Reference

#include <class_server_1_1_server.h>

Inheritance diagram for Server.Server:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  wantIPv4 ()
  wantIPv6 ()
  getClientIDList ()
  Returns a copy of the list of IDs of currently connected clients.
  getClientHost ()
  Returns an network address for the passed clientID.
  generateClientID ()
  Virtual - override this method to generate IDs differently in child classes.
  clientCount ()
  Returns the number of clients currently connected.
  start ()
  Starts the server.
  printSocketInformation ()
  run4 ()
  Don't call this - call start() instead!
  run6 ()
  Don't call this - call start() instead!
  run ()
  isRunning4 ()
  Returns True if the IPv4 server is accepting new clients.
  isRunning6 ()
  Returns True if the IPv6 server is accepting new clients.
  isRunning ()
  Returns True if either the IPv4 or IPv6 servers are accepting clients.
  isCreated4 ()
  isCreated6 ()
  stop ()
  Stops the server so that no new clients are accepted.
  broadcast ()
  Broadcasts the given data to the clients with the given IDs.
  registerRemoteClient ()
  Virtual - override this method to do any other operations required after registration.
  handleRemoteClientData ()
  Virtual - override this method to handle the data received from the clients.
  deregisterRemoteClient ()
  Removes the client with the given ID from the list of clients that this server manages.

Member Function Documentation

Server.Server.__init__ ( )
Server.Server.wantIPv4 ( )
Server.Server.wantIPv6 ( )
Server.Server.getClientIDList ( )

Returns a copy of the list of IDs of currently connected clients.

Server.Server.getClientHost ( )

Returns an network address for the passed clientID.

Server.Server.generateClientID ( )

Virtual - override this method to generate IDs differently in child classes.

Returns a unique ID for the given client.

Server.Server.clientCount ( )

Returns the number of clients currently connected.

Server.Server.start ( )

Starts the server.

Server.Server.printSocketInformation ( )
Server.Server.run4 ( )

Don't call this - call start() instead!

Server.Server.run6 ( )

Don't call this - call start() instead!

Server.Server.run ( )
Server.Server.isRunning4 ( )

Returns True if the IPv4 server is accepting new clients.

Server.Server.isRunning6 ( )

Returns True if the IPv6 server is accepting new clients.

Server.Server.isRunning ( )

Returns True if either the IPv4 or IPv6 servers are accepting clients.

Server.Server.isCreated4 ( )
Server.Server.isCreated6 ( )
Server.Server.stop ( )

Stops the server so that no new clients are accepted.

Any existing clients are disconnected.

Server.Server.broadcast ( )

Broadcasts the given data to the clients with the given IDs.

Server.Server.registerRemoteClient ( )

Virtual - override this method to do any other operations required after registration.

Adds the given client to the list of managed connected clients returns the generated client ID.

Reimplemented in MessageServer.MessageServer.

Server.Server.handleRemoteClientData ( )

Virtual - override this method to handle the data received from the clients.

Reimplemented in MessageServer.MessageServer.

Server.Server.deregisterRemoteClient ( )

Removes the client with the given ID from the list of clients that this server manages.

Reimplemented in MessageServer.MessageServer.


Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server
Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server Server.Server