Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

strmod::strmod::SimpleTelnetClient Class Reference

Only will handle the case when the server will do supress go ahead, and echo. More...

#include <StrMod/SimpleTelnetClient.h>

Inheritance diagram for strmod::strmod::SimpleTelnetClient:

Inheritance graph
[legend]
List of all members.

Public Types

enum  Sides { ToServer, ToUser }

Public Methods

virtual int AreYouA (const lcore::ClassIdent &cid) const
 Asks if a class is of a particular type, or publicly derived from that type.

virtual bool canCreate (int side) const
 Can a plug be created on the given side?

virtual bool ownsPlug (const Plug *plug) const
 Does the module own this plug?

virtual bool deletePlug (Plug *plug)
 Please delete this plug.

void reset ()
 Resets the states of the sent_do_supga_ and sent_do_echo_ flags.


Static Public Attributes

const STR_ClassIdent identifier
 A unique identifier for this class.


Protected Methods

virtual const lcore::ClassIdent * i_GetIdent () const
 Returns the class identifier for the class the object actually is.

virtual Plug * i_MakePlug (int side)
 Makes a plug on the given side.

bool doProtocol ()
void updatePlugFlags ()
const StrChunkPtr userRead ()
void serverWrite (const StrChunkPtr &ptr)

Friends

class UPlug
class SPlug

Detailed Description

Only will handle the case when the server will do supress go ahead, and echo.

This is a very simple telnet protocol handler. It won't support ANY options besides the server doing supress go ahead, and echo, and it requires the server to support and enable those options. This means that it will only do 'character at a time' mode.

Definition at line 45 of file SimpleTelnetClient.h.


Member Function Documentation

int strmod::strmod::SimpleTelnetClient::AreYouA const lcore::ClassIdent &    cid const [inline, virtual]
 

Asks if a class is of a particular type, or publicly derived from that type.

Overriden in every derived class (with a static identifier member) to compare against the identifier, then call the AreYouA methods of all the superclasses.

Parameters:
cid Usually <class>::identifier for the class you want to ask if the object is an instance of.

Reimplemented from strmod::strmod::StreamModule.

Definition at line 159 of file SimpleTelnetClient.h.

bool strmod::strmod::SimpleTelnetClient::deletePlug Plug *    plug [virtual]
 

Please delete this plug.

Modules are supposed to own plugs, so you aren't supposed to delete them yourself.

Returns false on failure. Failure could happen because module does not own the plug.

Implements strmod::strmod::StreamModule.

Definition at line 51 of file SimpleTelnetClient.cxx.

virtual const lcore::ClassIdent* strmod::strmod::SimpleTelnetClient::i_GetIdent   const [inline, protected, virtual]
 

Returns the class identifier for the class the object actually is.

Should always be overridden in any class that has a static identifier member.

Reimplemented from strmod::strmod::StreamModule.

Definition at line 70 of file SimpleTelnetClient.h.

StreamModule::Plug * strmod::strmod::SimpleTelnetClient::i_MakePlug int    side [protected, virtual]
 

Makes a plug on the given side.

Guaranteed to never be called if canCreate would return false. Must NEVER return 0 (NULL).

Implements strmod::strmod::StreamModule.

Definition at line 78 of file SimpleTelnetClient.cxx.

void strmod::strmod::SimpleTelnetClient::reset  
 

Resets the states of the sent_do_supga_ and sent_do_echo_ flags.

Resetting these flags has the effect of causing the client to attempt to renegotiate these options

Definition at line 68 of file SimpleTelnetClient.cxx.


The documentation for this class was generated from the following files:
Generated on Wed Jan 29 00:32:54 2003 for libNet by doxygen1.3-rc1