Jpp  master_rocky-37-gf0c5bc59d
the software that should make you happy
Public Member Functions | Static Public Attributes | Protected Attributes | Private Attributes | List of all members
JLANG::JFile Class Reference

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

#include <JFile.hh>

Inheritance diagram for JLANG::JFile:
JLANG::JAbstractFile JLANG::JBinaryInput JLANG::JBinaryOutput JLANG::JComparable< JAbstractFile > JNET::JSocket JNET::JTCPSocket JNET::JUDPSocket JNET::JClient JNET::JServerSocket JNET::JSocketBlocking JNET::JSocketNonblockingReader JNET::JSocketNonblockingWriter JNET::JControlHostServer JNET::JLigierObjectIterator< T > JNET::JControlHost KM3NETDAQ::JTarget JNET::JSocketInputChannel< JPrefix_t > JNET::JSocketOutputChannel< JPrefix_t > JNET::JControlHostObjectOutput< JTail_t > JNET::JControlHostObjectOutput< JHead_t > JLOGGER::JControlHostLogger JNET::JControlHostObjectIterator< T > JNET::JControlHostObjectOutput< T > JNET::JControlHostObjectOutput< JTypeList< JHead_t, JTail_t > > JNET::JControlHostObjectOutput< JTypeList< JHead_t, JNullType > > JNET::JControlHostObjectOutput< JTypeList< JHead_t, JTail_t > >

Public Member Functions

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

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.

35  :
36  JAbstractFile(),
37  result(0)
38  {}
JAbstractFile()
Default constructor.
int result
Definition: JFile.hh:170

◆ JFile() [2/2]

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

Constructor.

Parameters
filefile descriptor

Definition at line 46 of file JFile.hh.

46  :
47  JAbstractFile(file),
48  result(1)
49  {}

Member Function Documentation

◆ close()

int JLANG::JFile::close ( )
inline

Close file.

Returns
return value

Definition at line 57 of file JFile.hh.

58  {
59  int value = -1;
60 
61  if (fileDescriptor != FILE_CLOSED) {
62 
63  value = ::close(fileDescriptor);
64 
66  result = 0;
67  }
68 
69  return value;
70  }
static const int FILE_CLOSED
int close()
Close file.
Definition: JFile.hh:57

◆ read()

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

Read data from file.

Parameters
bufferbuffer
lengthnumber of bytes to read
Returns
number of bytes read

Implements JLANG::JBinaryInput.

Reimplemented in JNET::JUDPSocket, JNET::JSocketBlocking, and JNET::JSocket.

Definition at line 80 of file JFile.hh.

81  {
82  return (result = ::read(fileDescriptor, buffer, length));
83  }
virtual int read(char *buffer, const int length)
Read data from file.
Definition: JFile.hh:80

◆ write()

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

Write data to file.

Parameters
bufferbuffer
lengthnumber of bytes to write
Returns
number of bytes written

Implements JLANG::JBinaryOutput.

Reimplemented in JNET::JUDPSocket, JNET::JSocketBlocking, and JNET::JSocket.

Definition at line 93 of file JFile.hh.

94  {
95  return (result = ::write(fileDescriptor, buffer, length));
96  }
virtual int write(const char *buffer, const int length)
Write data to file.
Definition: JFile.hh:93

◆ 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
timeouttimeout
Returns
true if ready to read; else false

Definition at line 106 of file JFile.hh.

107  {
108  return JFileDescriptorMask(*this).in_avail(timeout);
109  }
Auxiliary class for method select.
bool in_avail(JTimeval timeout=JTimeval::min())
Check availability of input.

◆ 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
timeouttimeout
Returns
true if ready to write; else false

Definition at line 119 of file JFile.hh.

120  {
121  return JFileDescriptorMask(*this).out_avail(timeout);
122  }
bool out_avail(JTimeval timeout=JTimeval::min())
Check availability of output.

◆ 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.

131  {
132  return is_open() && !eof() && !bad();
133  }
bool is_open() const
Get open status.
virtual bool bad() const
Check status.
Definition: JFile.hh:152
virtual bool eof() const
Check end of file.
Definition: JFile.hh:163

◆ 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.

142  {
143  return result == 0;
144  }

◆ 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.

153  {
154  return fail();
155  }
virtual bool fail() const
Check status.
Definition: JFile.hh:141

◆ 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.

164  {
165  return result == EOF;
166  }

◆ less()

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

Less than operation.

Parameters
fileJAbstractFile to be compared
Returns
true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

65  {
66  return getFileDescriptor() < file.getFileDescriptor();
67  }
int getFileDescriptor() const
Get file descriptor.

◆ getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const
inlineinherited

Get file descriptor.

Returns
file descriptor

Definition at line 75 of file JAbstractFile.hh.

76  {
77  return fileDescriptor;
78  }

◆ setFileDescriptor()

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

Set file descriptor.

Parameters
filefile descriptor

Definition at line 86 of file JAbstractFile.hh.

87  {
88  fileDescriptor = file;
89  }

◆ is_open()

bool JLANG::JAbstractFile::is_open ( ) const
inlineinherited

Get open status.

Definition at line 95 of file JAbstractFile.hh.

96  {
97  return fileDescriptor != FILE_CLOSED;
98  }

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: