1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
.TH ACE_Asynch_Transmit_File::Header_And_Trailer 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Asynch_Transmit_File::Header_And_Trailer \- The class defines a data structure that contains pointers to data to send before and after the file data is sent.
.SH SYNOPSIS
.br
.PP
\fC#include <Asynch_IO.h>\fR
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBHeader_And_Trailer\fR (\fBACE_Message_Block\fR *header = 0, u_long header_bytes = 0, \fBACE_Message_Block\fR *trailer = 0, u_long trailer_bytes = 0)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "virtual \fB~Header_And_Trailer\fR (void)"
.br
.RI "\fIDestructor.\fR"
.ti -1c
.RI "void \fBheader_and_trailer\fR (\fBACE_Message_Block\fR *header = 0, u_long header_bytes = 0, \fBACE_Message_Block\fR *trailer = 0, u_long trailer_bytes = 0)"
.br
.RI "\fIThis method allows all the member to be set in one fell swoop.\fR"
.ti -1c
.RI "\fBACE_Message_Block\fR* \fBheader\fR (void) const"
.br
.RI "\fIHeader which goes before the file data.\fR"
.ti -1c
.RI "void \fBheader\fR (\fBACE_Message_Block\fR *message_block)"
.br
.ti -1c
.RI "u_long \fBheader_bytes\fR (void) const"
.br
.RI "\fISize of the header data.\fR"
.ti -1c
.RI "void \fBheader_bytes\fR (u_long bytes)"
.br
.ti -1c
.RI "\fBACE_Message_Block\fR* \fBtrailer\fR (void) const"
.br
.RI "\fITrailer which goes after the file data.\fR"
.ti -1c
.RI "void \fBtrailer\fR (\fBACE_Message_Block\fR *message_block)"
.br
.ti -1c
.RI "u_long \fBtrailer_bytes\fR (void) const"
.br
.RI "\fISize of the trailer data.\fR"
.ti -1c
.RI "void \fBtrailer_bytes\fR (u_long bytes)"
.br
.ti -1c
.RI "\fBACE_LPTRANSMIT_FILE_BUFFERS\fR \fBtransmit_buffers\fR (void)"
.br
.RI "\fIConversion routine.\fR"
.in -1c
.SS Protected Attributes
.in +1c
.ti -1c
.RI "\fBACE_Message_Block\fR* \fBheader_\fR"
.br
.RI "\fIHeader data.\fR"
.ti -1c
.RI "u_long \fBheader_bytes_\fR"
.br
.RI "\fISize of header data.\fR"
.ti -1c
.RI "\fBACE_Message_Block\fR* \fBtrailer_\fR"
.br
.RI "\fITrailer data.\fR"
.ti -1c
.RI "u_long \fBtrailer_bytes_\fR"
.br
.RI "\fISize of trailer data.\fR"
.ti -1c
.RI "\fBACE_TRANSMIT_FILE_BUFFERS\fR \fBtransmit_buffers_\fR"
.br
.RI "\fITarget data structure.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
The class defines a data structure that contains pointers to data to send before and after the file data is sent.
.PP
.PP
This class provides a wrapper over TRANSMIT_FILE_BUFFERS and provided a consistent use of ACE_Message_Blocks.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Asynch_Transmit_File::Header_And_Trailer::Header_And_Trailer (\fBACE_Message_Block\fR * header = 0, u_long header_bytes = 0, \fBACE_Message_Block\fR * trailer = 0, u_long trailer_bytes = 0)
.PP
Constructor.
.PP
.SS ACE_Asynch_Transmit_File::Header_And_Trailer::~Header_And_Trailer (void)\fC [virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS void ACE_Asynch_Transmit_File::Header_And_Trailer::header (\fBACE_Message_Block\fR * message_block)
.PP
.SS \fBACE_Message_Block\fR * ACE_Asynch_Transmit_File::Header_And_Trailer::header (void) const
.PP
Header which goes before the file data.
.PP
.SS void ACE_Asynch_Transmit_File::Header_And_Trailer::header_and_trailer (\fBACE_Message_Block\fR * header = 0, u_long header_bytes = 0, \fBACE_Message_Block\fR * trailer = 0, u_long trailer_bytes = 0)
.PP
This method allows all the member to be set in one fell swoop.
.PP
.SS void ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes (u_long bytes)
.PP
.SS u_long ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes (void) const
.PP
Size of the header data.
.PP
.SS void ACE_Asynch_Transmit_File::Header_And_Trailer::trailer (\fBACE_Message_Block\fR * message_block)
.PP
.SS \fBACE_Message_Block\fR * ACE_Asynch_Transmit_File::Header_And_Trailer::trailer (void) const
.PP
Trailer which goes after the file data.
.PP
.SS void ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes (u_long bytes)
.PP
.SS u_long ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes (void) const
.PP
Size of the trailer data.
.PP
.SS \fBACE_LPTRANSMIT_FILE_BUFFERS\fR ACE_Asynch_Transmit_File::Header_And_Trailer::transmit_buffers (void)
.PP
Conversion routine.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS \fBACE_Message_Block\fR * ACE_Asynch_Transmit_File::Header_And_Trailer::header_\fC [protected]\fR
.PP
Header data.
.PP
.SS u_long ACE_Asynch_Transmit_File::Header_And_Trailer::header_bytes_\fC [protected]\fR
.PP
Size of header data.
.PP
.SS \fBACE_Message_Block\fR * ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_\fC [protected]\fR
.PP
Trailer data.
.PP
.SS u_long ACE_Asynch_Transmit_File::Header_And_Trailer::trailer_bytes_\fC [protected]\fR
.PP
Size of trailer data.
.PP
.SS \fBACE_TRANSMIT_FILE_BUFFERS\fR ACE_Asynch_Transmit_File::Header_And_Trailer::transmit_buffers_\fC [protected]\fR
.PP
Target data structure.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|