E-MailRelay
Public Member Functions | Protected Member Functions | List of all members
GNet::BufferedServerPeer Class Referenceabstract

A ServerPeer that does line-buffering on input. More...

#include <gbufferedserverpeer.h>

+ Inheritance diagram for GNet::BufferedServerPeer:

Public Member Functions

 BufferedServerPeer (Server::PeerInfo, LineBufferConfig)
 Constructor.
 
virtual ~BufferedServerPeer ()
 Destructor.
 
std::string lineBufferEndOfLine () const
 Returns the line buffer end-of-line string. More...
 
void expect (size_t n)
 Temporarily suspends line buffering so that the next 'n' bytes are accumulated without regard to line terminators. More...
 
- Public Member Functions inherited from GNet::ServerPeer
 ServerPeer (Server::PeerInfo)
 Constructor. More...
 
bool send (const std::string &data, std::string::size_type offset=0U)
 Sends data down the socket to the peer. More...
 
bool send (const std::vector< std::pair< const char *, size_t > > &data)
 Overload to send data using scatter-gather segments. More...
 
void doDelete (const std::string &=std::string())
 Calls onDelete() and schedules a "delete this".
 
std::string logId () const
 Returns an identification string for logging purposes.
 
virtual std::pair< bool, Address > localAddress () const override
 Returns the local address. More...
 
virtual std::pair< bool, Address > peerAddress () const override
 Returns the peer address. More...
 
virtual std::string connectionState () const override
 Returns the connection state display string. More...
 
virtual std::string peerCertificate () const override
 Returns the peer's TLS certificate. More...
 
virtual void readEvent () override
 Override from GNet::EventHandler. More...
 
virtual void writeEvent () override
 Override from GNet::EventHandler. More...
 
virtual void otherEvent (EventHandler::Reason) override
 Override from GNet::EventHandler. More...
 
void doDeleteThis (int)
 Does delete this. Should only be used by the GNet::Server class.
 
- Public Member Functions inherited from GNet::EventHandler
virtual ~EventHandler ()
 Destructor.
 
- Public Member Functions inherited from GNet::Connection
virtual ~Connection ()
 Destructor.
 
- Public Member Functions inherited from GNet::SocketProtocolSink
virtual ~SocketProtocolSink ()
 Destructor.
 

Protected Member Functions

virtual bool onReceive (const char *line_data, size_t line_size, size_t eolsize)=0
 Called when a complete line is received from the peer. More...
 
virtual void onData (const char *, ServerPeer::size_type) override
 Override from GNet::SocketProtocolSink.
 
- Protected Member Functions inherited from GNet::ServerPeer
virtual ~ServerPeer ()
 Destructor. More...
 
virtual void onDelete (const std::string &reason)=0
 Called just before destruction. More...
 
virtual void onSendComplete ()=0
 Called after flow-control has been released and all residual data sent. More...
 
void secureAccept ()
 Waits for the peer to start a secure session. More...
 
StreamSocket & socket ()
 Returns a reference to the client-server connection socket. More...
 
Server * server ()
 Returns a pointer to the associated server object. More...
 
virtual void onException (std::exception &) override
 Override from GNet::ExceptionHandler.
 
- Protected Member Functions inherited from GNet::ExceptionHandler
virtual ~ExceptionHandler ()
 Destructor.
 
- Protected Member Functions inherited from GNet::SocketProtocolSink
virtual void onData (const char *, size_t)=0
 Called when data is read from the socket.
 
virtual void onSecure (const std::string &peer_certificate)=0
 Called once the secure socket protocol has been successfully negotiated. More...
 

Additional Inherited Members

- Public Types inherited from GNet::ServerPeer
typedef std::string::size_type size_type
 
- Public Types inherited from GNet::EventHandler
enum  Reason {
  reason_closed, reason_down, reason_reset, reason_abort,
  reason_other
}
 
- Static Public Member Functions inherited from GNet::EventHandler
static std::string str (Reason)
 Returns a printable description of the other-event reason. More...
 

Detailed Description

A ServerPeer that does line-buffering on input.

Definition at line 39 of file gbufferedserverpeer.h.

Member Function Documentation

void GNet::BufferedServerPeer::expect ( size_t  n)

Temporarily suspends line buffering so that the next 'n' bytes are accumulated without regard to line terminators.

Definition at line 46 of file gbufferedserverpeer.cpp.

std::string GNet::BufferedServerPeer::lineBufferEndOfLine ( ) const

Returns the line buffer end-of-line string.

Returns the empty string if auto-detecting and not yet auto-detected.

Definition at line 51 of file gbufferedserverpeer.cpp.

virtual bool GNet::BufferedServerPeer::onReceive ( const char *  line_data,
size_t  line_size,
size_t  eolsize 
)
protectedpure virtual

Called when a complete line is received from the peer.

Returns false if no more lines should be delivered.

Implemented in GSmtp::AdminServerPeer, and GPop::ServerPeer.


The documentation for this class was generated from the following files: