SourcePro® API Reference Guide

 
List of all members | Public Types | Public Member Functions
RWNetBuf Class Reference

Network communication buffer class. More...

#include <rw/network/RWNetBuf.h>

Public Types

enum  State { normal, eof }
 

Public Member Functions

 RWNetBuf ()
 
 RWNetBuf (const RWCString &buf, State state=normal)
 
RWCString getData () const
 
State getState () const
 
 operator bool () const
 
 operator RWCString () const
 

Detailed Description

RWNetBuf is a network communication buffer class. A network communication buffer contains bytes of data and associated flags that indicate the state of the buffer. An RWNetBuf should not be confused with a TLI netbuf (TLI is the Unix System V network communication interface).

Member Enumeration Documentation

The State enum indicates the state of the buffer.

Enumerator
normal 

Nothing special

eof 

End of file

Constructor & Destructor Documentation

RWNetBuf::RWNetBuf ( )

Constructs an empty buffer.

RWNetBuf::RWNetBuf ( const RWCString buf,
State  state = normal 
)

Constructs a buffer from an RWCString. The optional state parameter indicates the state of the buffer at the time of construction.

Member Function Documentation

RWCString RWNetBuf::getData ( void  ) const
inline

Returns an RWCString containing the buffer's contents.

RWNetBuf::State RWNetBuf::getState ( ) const
inline

Returns the state of the buffer.

RWNetBuf::operator bool ( ) const

Returns true if the state of the buffer is normal.

RWNetBuf::operator RWCString ( ) const

Returns an RWCString containing the buffer's contents.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.