ACE_FILE Class Reference

Defines the core methods of the ACE_FILE abstraction. More...

#include <FILE.h>

Inheritance diagram for ACE_FILE:

Collaboration diagram for ACE_FILE:

Public Member Functions
int	close (void)
int	remove (void)
	Close and remove the ACE_FILE from the file system. More...
int	unlink (void)
int	get_info (ACE_FILE_Info *finfo)
	Get information on this ACE_FILE. More...
int	get_info (ACE_FILE_Info &finfo)
	Get information on this ACE_FILE. More...
int	truncate (ACE_OFF_T length)
	Set filesize to length byte. More...
ACE_OFF_T	seek (ACE_OFF_T offset, int whence=SEEK_CUR)
ACE_OFF_T	tell (void)
	Return an offset for the file handle. More...
int	disable (int signum) const
int	get_local_addr (ACE_Addr &) const
int	get_remote_addr (ACE_Addr &) const
	Return the same thing as get_local_addr(). More...
void	dump (void) const
	Dump the state of an object. More...
Public Member Functions inherited from ACE_IO_SAP
	~ACE_IO_SAP (void)
	Default dtor. More...
int	control (int cmd, void *) const
	Interface for ioctl. More...
int	enable (int value) const
int	disable (int value) const
ACE_HANDLE	get_handle (void) const
	Get the underlying handle. More...
void	set_handle (ACE_HANDLE handle)
	Set the underlying handle. More...
void	dump (void) const
	Dump the state of an object. More...

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...
Public Attributes inherited from ACE_IO_SAP
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Protected Member Functions
	ACE_FILE (void)
Protected Member Functions inherited from ACE_IO_SAP
	ACE_IO_SAP (void)
	Ensure that ACE_IO_SAP is an abstract base class. More...

Protected Attributes
ACE_FILE_Addr	addr_
	File we are "connected" with... More...

Additional Inherited Members
Public Types inherited from ACE_IO_SAP
enum	{ INVALID_HANDLE = -1 }

Detailed Description

Defines the core methods of the ACE_FILE abstraction.

Constructor & Destructor Documentation

ACE_FILE::ACE_FILE ( void  )

protected

Ensure that this class is only created by the ACE_FILE_Connector.

Member Function Documentation

int ACE_FILE::close

(

void

)

Close the ACE_FILE handle without removing the ACE_FILE from the file system.

int ACE_FILE::disable ( int  signum ) const

inline

Disable signal signum This is here to prevent Win32 from disabling SPIPE using socket calls

void ACE_FILE::dump

(

void

)

const

Dump the state of an object.

int ACE_FILE::get_info

(

ACE_FILE_Info *

finfo

)

Get information on this ACE_FILE.

int ACE_FILE::get_info

(

ACE_FILE_Info &

finfo

)

Get information on this ACE_FILE.

int ACE_FILE::get_local_addr

(

ACE_Addr &

addr

)

const

Return the local endpoint address in the referenced ACE_Addr. Returns 0 if successful, else -1.

int ACE_FILE::get_remote_addr

(

ACE_Addr &

addr

)

const

Return the same thing as get_local_addr().

int ACE_FILE::remove

(

void

)

Close and remove the ACE_FILE from the file system.

ACE_OFF_T ACE_FILE::seek	(	ACE_OFF_T	offset,
		int	whence = SEEK_CUR
	)

Sets the file pointer as follows: o If @ whence is SEEK_SET, the pointer is set to offset bytes.

o If whence> is SEEK_CUR, the pointer is set to its current location plus offset.

o If whence is SEEK_END, the pointer is set to the size of the file plus offset.

ACE_OFF_T ACE_FILE::tell

(

void

)

Return an offset for the file handle.

int ACE_FILE::truncate

(

ACE_OFF_T

length

)

Set filesize to length byte.

int ACE_FILE::unlink

(

void

)

Remove the ACE_FILE from the file system without closing the ACE_FILE handle.

Member Data Documentation

ACE_FILE::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_FILE_Addr ACE_FILE::addr_

protected

File we are "connected" with...

---

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

• FILE.h
• FILE.cpp
• FILE.inl