ACE_Asynch_Transmit_File::Header_And_Trailer Class Reference

The class defines a data structure that contains pointers to data to send before and after the file data is sent. More...

#include <Asynch_IO.h>

Collaboration diagram for ACE_Asynch_Transmit_File::Header_And_Trailer:

Public Member Functions
	Header_And_Trailer (ACE_Message_Block *header=0, size_t header_bytes=0, ACE_Message_Block *trailer=0, size_t trailer_bytes=0)
	Constructor.
virtual	~Header_And_Trailer ()
	Destructor.
void	header_and_trailer (ACE_Message_Block *header=0, size_t header_bytes=0, ACE_Message_Block *trailer=0, size_t trailer_bytes=0)
	This method allows all the member to be set in one fell swoop.
ACE_Message_Block *	header () const
	Get header which goes before the file data.
void	header (ACE_Message_Block *message_block)
	Set header which goes before the file data.
size_t	header_bytes () const
	Get size of the header data.
void	header_bytes (size_t bytes)
	Set size of the header data.
ACE_Message_Block *	trailer () const
	Get trailer which goes after the file data.
void	trailer (ACE_Message_Block *message_block)
	Set trailer which goes after the file data.
size_t	trailer_bytes () const
	Get size of the trailer data.
void	trailer_bytes (size_t bytes)
	Set size of the trailer data.
ACE_LPTRANSMIT_FILE_BUFFERS	transmit_buffers ()
	Conversion routine.

Protected Attributes
ACE_Message_Block *	header_
	Header data.
size_t	header_bytes_
	Size of header data.
ACE_Message_Block *	trailer_
	Trailer data.
size_t	trailer_bytes_
	Size of trailer data.
ACE_TRANSMIT_FILE_BUFFERS	transmit_buffers_
	Target data structure.

Detailed Description

The class defines a data structure that contains pointers to data to send before and after the file data is sent.

This class provides a wrapper over TRANSMIT_FILE_BUFFERS and provided a consistent use of ACE_Message_Blocks.

Constructor & Destructor Documentation

Header_And_Trailer()

ACE_Asynch_Transmit_File::Header_And_Trailer::Header_And_Trailer	(	ACE_Message_Block *	header = 0,
		size_t	header_bytes = 0,
		ACE_Message_Block *	trailer = 0,
		size_t	trailer_bytes = 0 )

Constructor.

~Header_And_Trailer()

ACE_Asynch_Transmit_File::Header_And_Trailer::~Header_And_Trailer ( )

virtual

Destructor.

Member Function Documentation

header() [1/2]

ACE_Message_Block * ACE_Asynch_Transmit_File::Header_And_Trailer::header

(

)

const

Get header which goes before the file data.

header() [2/2]

void ACE_Asynch_Transmit_File::Header_And_Trailer::header

(

ACE_Message_Block *

message_block

)

Set header which goes before the file data.

header_and_trailer()

void ACE_Asynch_Transmit_File::Header_And_Trailer::header_and_trailer	(	ACE_Message_Block *	header = 0,
		size_t	header_bytes = 0,
		ACE_Message_Block *	trailer = 0,
		size_t	trailer_bytes = 0 )

This method allows all the member to be set in one fell swoop.

header_bytes() [1/2]

size_t ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes

(

)

const

Get size of the header data.

header_bytes() [2/2]

void ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes

(

size_t

bytes

)

Set size of the header data.

trailer() [1/2]

ACE_Message_Block * ACE_Asynch_Transmit_File::Header_And_Trailer::trailer

(

)

const

Get trailer which goes after the file data.

trailer() [2/2]

void ACE_Asynch_Transmit_File::Header_And_Trailer::trailer

(

ACE_Message_Block *

message_block

)

Set trailer which goes after the file data.

trailer_bytes() [1/2]

size_t ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes

(

)

const

Get size of the trailer data.

trailer_bytes() [2/2]

void ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes

(

size_t

bytes

)

Set size of the trailer data.

transmit_buffers()

ACE_LPTRANSMIT_FILE_BUFFERS ACE_Asynch_Transmit_File::Header_And_Trailer::transmit_buffers

(

)

Conversion routine.

Member Data Documentation

header_

ACE_Message_Block* ACE_Asynch_Transmit_File::Header_And_Trailer::header_

protected

Header data.

header_bytes_

size_t ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes_

protected

Size of header data.

trailer_

ACE_Message_Block* ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_

protected

Trailer data.

trailer_bytes_

size_t ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes_

protected

Size of trailer data.

transmit_buffers_

ACE_TRANSMIT_FILE_BUFFERS ACE_Asynch_Transmit_File::Header_And_Trailer::transmit_buffers_

protected

Target data structure.

---

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

• Asynch_IO.h
• Asynch_IO.cpp