JLANG::JFile Class Reference

The JFile class extends the JAbstractFile class. More...

#include <JFile.hh>

Inheritance diagram for JLANG::JFile:

Public Member Functions
	JFile ()
	Default constructor.
	JFile (const JAbstractFile &file)
	Constructor.
int	close ()
	Close file.
virtual int	read (char *buffer, const int length) override
	Read data from file.
virtual int	write (const char *buffer, const int length) override
	Write data to file.
bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input.
bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output.
virtual bool	good () const
	Check status.
virtual bool	fail () const
	Check status.
virtual bool	bad () const
	Check status.
virtual bool	eof () const
	Check end of file.
bool	less (const JAbstractFile &file) const
	Less than operation.
int	getFileDescriptor () const
	Get file descriptor.
void	setFileDescriptor (const int file)
	Set file descriptor.
bool	is_open () const
	Get open status.

Static Public Attributes
static const int	FILE_CLOSED = -1

Protected Attributes
int	fileDescriptor

Private Attributes
int	result

Detailed Description

The JFile class extends the JAbstractFile class.

This class implements the JBinaryInput and JBinaryOutput interfaces.

Definition at line 26 of file JFile.hh.

Constructor & Destructor Documentation

JFile() [1/2]

JLANG::JFile::JFile ( )

inline

Default constructor.

Definition at line 35 of file JFile.hh.

            :
      JAbstractFile(),
      result(0)
    {}

JFile() [2/2]

JLANG::JFile::JFile ( const JAbstractFile & file )

inline

Constructor.

Parameters

file	file descriptor

Definition at line 46 of file JFile.hh.

                                     :
      JAbstractFile(file),
      result(1)
    {}

Member Function Documentation

close()

int JLANG::JFile::close ( )

inline

Close file.

Returns

return value

Definition at line 57 of file JFile.hh.

    {
      int value = -1;
 
      if (fileDescriptor != FILE_CLOSED) {
 
        value = ::close(fileDescriptor);
 
        fileDescriptor = FILE_CLOSED;
        result         = 0;
      }
 
      return value;
    }

read()

virtual int JLANG::JFile::read ( char * buffer, const int length )

inlineoverridevirtual

Read data from file.

Parameters

buffer	buffer
length	number of bytes to read

Returns

number of bytes read

Implements JLANG::JBinaryInput.

Reimplemented in JNET::JSocket, JNET::JSocketBlocking, JNET::JSocketInputChannel< JPrefix_t >, JNET::JSocketNonblockingReader, and JNET::JUDPSocket.

Definition at line 80 of file JFile.hh.

    {
      return (result = ::read(fileDescriptor, buffer, length));
    }

write()

virtual int JLANG::JFile::write ( const char * buffer, const int length )

inlineoverridevirtual

Write data to file.

Parameters

buffer	buffer
length	number of bytes to write

Returns

number of bytes written

Implements JLANG::JBinaryOutput.

Reimplemented in JNET::JSocket, JNET::JSocketBlocking, JNET::JSocketNonblockingWriter, JNET::JSocketOutputChannel< JPrefix_t >, and JNET::JUDPSocket.

Definition at line 93 of file JFile.hh.

    {
      return (result = ::write(fileDescriptor, buffer, length));
    }

in_avail()

bool JLANG::JFile::in_avail ( JTimeval timeout = JTimeval::min() ) const

inline

Check availability of input.

This method returns true if at least one byte can be read without blocking.

Parameters

timeout

timeout

Returns

true if ready to read; else false

Definition at line 106 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).in_avail(timeout);
    }

out_avail()

bool JLANG::JFile::out_avail ( JTimeval timeout = JTimeval::min() ) const

inline

Check availability of output.

This method returns true if at least one byte can be written without blocking.

Parameters

timeout

timeout

Returns

true if ready to write; else false

Definition at line 119 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).out_avail(timeout);
    }

good()

virtual bool JLANG::JFile::good ( ) const

inlinevirtual

Check status.

Returns

true if last I/O operation successful; else false

Definition at line 130 of file JFile.hh.

    {
      return is_open() && !eof() && !bad();
    }

fail()

virtual bool JLANG::JFile::fail ( ) const

inlinevirtual

Check status.

Returns

true if last I/O operation caused logical error; else false

Definition at line 141 of file JFile.hh.

    {
      return result == 0;
    }

bad()

virtual bool JLANG::JFile::bad ( ) const

inlinevirtual

Check status.

Returns

true if last I/O operation caused read/write error; else false

Definition at line 152 of file JFile.hh.

    {
      return fail();
    }

eof()

virtual bool JLANG::JFile::eof ( ) const

inlinevirtual

Check end of file.

Returns

true if end of file; else false

Definition at line 163 of file JFile.hh.

    {
      return result == EOF;
    }

less()

bool JLANG::JAbstractFile::less ( const JAbstractFile & file ) const

inlineinherited

Less than operation.

Parameters

file	JAbstractFile to be compared

Returns

true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

    {
      return getFileDescriptor() < file.getFileDescriptor();
    }

getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const

inlineinherited

Get file descriptor.

Returns

file descriptor

Definition at line 75 of file JAbstractFile.hh.

    {
      return fileDescriptor;
    }

setFileDescriptor()

void JLANG::JAbstractFile::setFileDescriptor ( const int file )

inlineinherited

Set file descriptor.

Parameters

file	file descriptor

Definition at line 86 of file JAbstractFile.hh.

    {
      fileDescriptor = file;
    }

is_open()

bool JLANG::JAbstractFile::is_open ( ) const

inlineinherited

Get open status.

Definition at line 95 of file JAbstractFile.hh.

    {
      return fileDescriptor != FILE_CLOSED;
    }

Member Data Documentation

result

int JLANG::JFile::result

private

Definition at line 170 of file JFile.hh.

FILE_CLOSED

const int JLANG::JAbstractFile::FILE_CLOSED = -1

staticinherited

Definition at line 27 of file JAbstractFile.hh.

fileDescriptor

int JLANG::JAbstractFile::fileDescriptor

protectedinherited

Definition at line 102 of file JAbstractFile.hh.

---

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

• JFile.hh