FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEfileDescriptor Class Referencefinal

Filesystem-specific I/O descriptor. More...

#include <OMEfileDescriptor.h>

+ Inheritance diagram for OMEfileDescriptor:

Public Member Functions

 OMEfileDescriptor (uint64_t handle, OMEioEvent::OMEfileType type, const OMEstring *fileName)
 
 ~OMEfileDescriptor ()
 
virtual int readBytes (unsigned char *bfr, size_t bytes, size_t *actualBytes, int *errRet) override
 
virtual int writeBytes (const unsigned char *bfr, size_t bytes, size_t *actualBytes, int *errRet) override
 
virtual int writeVectorOfBytes (const OMEioVector *v, uint_fast16_t elementCount, size_t *actualBytes, int *errRet, size_t skipBytes=0) override
 
virtual OMEeventselectForRead (OMEeventCallbackFP func, OMEthread *t=nullptr) override
 
virtual OMEeventselectForWrite (OMEeventCallbackFP func, OMEthread *t=nullptr) override
 
virtual OMEioDescriptoracceptConnection (int *errRet) override
 
virtual int seekToOffset (size_t offset) override
 
virtual int close (int mask) override
 
virtual OMEstringgetLocalAddress () const override
 
virtual bool isOpen () const override
 
- Public Member Functions inherited from OMEioDescriptor
 OMEioDescriptor (uint64_t handle, OMEioEvent::OMEfileType type)
 
virtual ~OMEioDescriptor ()
 
uint64_t getSelectHandle () const OME_ALWAYS_INLINE
 
virtual int receiveDatagram (unsigned char *bfr, size_t bytes, size_t *actualBytes, OMEstring *fromInfo, int *errRet)
 
virtual int sendDatagram (const unsigned char *bfr, size_t bytes, size_t *actualBytes, const char *toInfo, int *errRet)
 
virtual OMEstringgetPeerAddress () const
 
virtual int getErrorStatus () const
 
uint_fast16_t adjustVector (OMEioVector *result, uint_fast16_t count, const OMEioVector *v, size_t skipCount)
 

Static Public Member Functions

static OMEioDescriptoropenFileScheme (const OMEstring &url, int *errRet=nullptr)
 
- Static Public Member Functions inherited from OMEioDescriptor
static OMEioDescriptoropenIOscheme (const char *name, uint32_t openMode)
 

Static Private Member Functions

static OMEioDescriptoropenFile (const char *name, uint32_t openMode, int *errRC=nullptr)
 

Private Attributes

OMEstring localName
 
bool fileIsOpen
 

Additional Inherited Members

- Public Types inherited from OMEioDescriptor
enum  OMEopenMode {
  read =OME_IO_READ, write =OME_IO_WRITE, listen =OME_IO_LISTEN, connect =OME_IO_CONNECT,
  create =OME_IO_CREATE, mustExist =OME_IO_MUST_EXIST, truncate =OME_IO_TRUNCATE, append =OME_IO_APPEND,
  nonblocking =OME_IO_NONBLOCKING, datagram =OME_IO_DATAGRAM, raw =OME_IO_RAW, multicast =OME_IO_MULTICAST
}
 
- Public Attributes inherited from OMEioDescriptor
uint64_t ioHandle
 
OMEioEvent::OMEfileType descriptorType
 

Detailed Description

Filesystem-specific I/O descriptor.

Constructor & Destructor Documentation

◆ OMEfileDescriptor()

OMEfileDescriptor::OMEfileDescriptor ( uint64_t  handle,
OMEioEvent::OMEfileType  type,
const OMEstring fileName 
)

Referenced by openFile().

◆ ~OMEfileDescriptor()

OMEfileDescriptor::~OMEfileDescriptor ( )

Member Function Documentation

◆ acceptConnection()

OMEioDescriptor * OMEfileDescriptor::acceptConnection ( int *  errRet)
overridevirtual

Reimplemented from OMEioDescriptor.

◆ close()

int OMEfileDescriptor::close ( int  mask)
overridevirtual

◆ getLocalAddress()

OMEstring * OMEfileDescriptor::getLocalAddress ( ) const
overridevirtual

Reimplemented from OMEioDescriptor.

References localName.

◆ isOpen()

virtual bool OMEfileDescriptor::isOpen ( ) const
inlineoverridevirtual

Implements OMEioDescriptor.

References fileIsOpen.

◆ openFile()

OMEioDescriptor * OMEfileDescriptor::openFile ( const char *  name,
uint32_t  openMode,
int *  errRC = nullptr 
)
staticprivate

◆ openFileScheme()

◆ readBytes()

int OMEfileDescriptor::readBytes ( unsigned char *  bfr,
size_t  bytes,
size_t *  actualBytes,
int *  errRet 
)
overridevirtual

Implements OMEioDescriptor.

◆ seekToOffset()

int OMEfileDescriptor::seekToOffset ( size_t  offset)
overridevirtual

Reimplemented from OMEioDescriptor.

References OMEioDescriptor::ioHandle, and SEEK_SET.

◆ selectForRead()

OMEevent * OMEfileDescriptor::selectForRead ( OMEeventCallbackFP  func,
OMEthread t = nullptr 
)
overridevirtual

Implements OMEioDescriptor.

◆ selectForWrite()

OMEevent * OMEfileDescriptor::selectForWrite ( OMEeventCallbackFP  func,
OMEthread t = nullptr 
)
overridevirtual

Implements OMEioDescriptor.

◆ writeBytes()

int OMEfileDescriptor::writeBytes ( const unsigned char *  bfr,
size_t  bytes,
size_t *  actualBytes,
int *  errRet 
)
overridevirtual

Implements OMEioDescriptor.

◆ writeVectorOfBytes()

int OMEfileDescriptor::writeVectorOfBytes ( const OMEioVector v,
uint_fast16_t  elementCount,
size_t *  actualBytes,
int *  errRet,
size_t  skipBytes = 0 
)
overridevirtual

Reimplemented from OMEioDescriptor.

References MAX_IO_VECTORS.

Member Data Documentation

◆ fileIsOpen

bool OMEfileDescriptor::fileIsOpen
private

Referenced by close(), and isOpen().

◆ localName

OMEstring OMEfileDescriptor::localName
private

Referenced by getLocalAddress().


The documentation for this class was generated from the following files:
Generated: Tue Jul 28 2020 16:03:27
Support Information