Module Rex::IO::StreamServer
In: lib/rex/io/stream_server.rb

This mixin provides the framework and interface for implementing a streaming server that can listen for and accept stream client connections. Stream servers extend this class and are required to implement the following methods: 

  accept
  fd

Methods

close_client   monitor_clients   monitor_listener   on_client_close   on_client_connect   on_client_data   start   stop  

Attributes

on_client_close_proc  [RW]  This callback procedure can be set and will be called when a client disconnects from the server.
on_client_connect_proc  [RW]  This callback procedure can be set and will be called when new clients connect.
on_client_data_proc  [RW]  This callback procedure can be set and will be called when clients have data to be processed.

Public Instance methods

close_client(client)

This method closes a client connection and cleans up the resources associated with it.

on_client_close(client)

This callback is notified when a client connection has closed.

on_client_connect(client)

This callback is notified when a client connects.

on_client_data(client)

This callback is notified when a client connection has data that needs to be processed.

start()

Start monitoring the listener socket for connections and keep track of all client connections.

stop()

Terminates the listener monitoring threads and closes all active clients.

Protected Instance methods

monitor_clients()

This method monitors client connections for data and calls the on_client_data routine when new data arrives.

monitor_listener()

This method monitors the listener socket for new connections and calls the on_client_connect callback routine.

[Validate]