xrootd
Public Types | Public Member Functions | List of all members
XrdSfsXio Class Referenceabstract

#include <XrdSfsXio.hh>

Public Types

enum  XioStatus {
  allOK = 0, BadBuff, BadHandle, NotWrite,
  TooMany
}
 Values return by Swap(). More...
 

Public Member Functions

virtual XioStatus Swap (const char *curBuff, XrdSfsXioHandle *&curHand, XrdSfsXioHandle *oldHand=0)=0
 
 XrdSfsXio ()
 Constructor and destructor. More...
 
virtual ~XrdSfsXio ()
 

Member Enumeration Documentation

◆ XioStatus

Values return by Swap().

Enumerator
allOK 

Successful completion.

BadBuff 

Swap failed, curBuff is bad.

BadHandle 

Swap failed, oHandle is bad.

NotWrite 

Swap failed, not from a write() call.

TooMany 

Swap failed, too many buffs outstanding.

Constructor & Destructor Documentation

◆ XrdSfsXio()

XrdSfsXio::XrdSfsXio ( )
inline

Constructor and destructor.

◆ ~XrdSfsXio()

virtual XrdSfsXio::~XrdSfsXio ( )
inlinevirtual

Member Function Documentation

◆ Swap()

virtual XioStatus XrdSfsXio::Swap ( const char *  curBuff,
XrdSfsXioHandle *&  curHand,
XrdSfsXioHandle oldHand = 0 
)
pure virtual

Swap the current I/O buffer

Parameters
curBuff- The address of the current buffer. It must match the the buffer that was most recently passed to the caller.
curHand- Where the handle associated with curBuff is to be placed.
oldHand- The handle associated with a buffer returned by a previous call to Swap(). A value of zero indicates that the caller is taking control of the buffer but has no replacement buffer.
Returns
!allOK One or more arguments or context is invalid. Nothing was swapped. The returned value describes the problem. The curHand has been set to zero.
=allOK The handle associated with curBuff has been placed in curHand. This handle must be used in a future Swap() call.

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