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
|
.TH ACE_FILE_Addr 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_FILE_Addr \- Defines the FILE address family address format.
.SH SYNOPSIS
.br
.PP
\fC#include <FILE_Addr.h>\fR
.PP
Inherits \fBACE_Addr\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_FILE_Addr\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.ti -1c
.RI "\fBACE_FILE_Addr\fR (const ACE_FILE_Addr &sa)"
.br
.RI "\fICopy constructor.\fR"
.ti -1c
.RI "int \fBset\fR (const ACE_FILE_Addr &sa)"
.br
.RI "\fIActs like a copy constructor. If <sa> == \fBACE_Addr::sap_any\fR then create a temporary filename using .\fR"
.ti -1c
.RI "ACE_EXPLICIT \fBACE_FILE_Addr\fR (const \fBACE_TCHAR\fR *filename)"
.br
.RI "\fICreate a ACE_FILE_Addr from a pathname.\fR"
.ti -1c
.RI "int \fBset\fR (const \fBACE_TCHAR\fR *filename)"
.br
.RI "\fICreate a ACE_FILE_Addr from a pathname.\fR"
.ti -1c
.RI "ACE_FILE_Addr& \fBoperator=\fR (const ACE_FILE_Addr &)"
.br
.RI "\fIAssignment operator.\fR"
.ti -1c
.RI "virtual void* \fBget_addr\fR (void) const"
.br
.RI "\fIReturn a pointer to the address.\fR"
.ti -1c
.RI "virtual int \fBaddr_to_string\fR (\fBACE_TCHAR\fR *addr, size_t) const"
.br
.RI "\fITransform the current address into string format.\fR"
.ti -1c
.RI "int \fBoperator==\fR (const ACE_FILE_Addr &SAP) const"
.br
.RI "\fICompare two addresses for equality.\fR"
.ti -1c
.RI "int \fBoperator!=\fR (const ACE_FILE_Addr &SAP) const"
.br
.RI "\fICompare two addresses for inequality.\fR"
.ti -1c
.RI "const \fBACE_TCHAR\fR* \fBget_path_name\fR (void) const"
.br
.RI "\fIReturn the path name used for the rendezvous point.\fR"
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.in -1c
.SS Public Attributes
.in +1c
.ti -1c
.RI "\fBACE_ALLOC_HOOK_DECLARE\fR"
.br
.RI "\fIDeclare the dynamic allocation hooks.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "\fBACE_TCHAR\fR \fBfilename_\fR [MAXNAMLEN + 1]"
.br
.RI "\fIName of the file.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
Defines the FILE address family address format.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_FILE_Addr::ACE_FILE_Addr (void)
.PP
Default constructor.
.PP
.SS ACE_FILE_Addr::ACE_FILE_Addr (const ACE_FILE_Addr & sa)
.PP
Copy constructor.
.PP
.SS ACE_EXPLICIT ACE_FILE_Addr::ACE_FILE_Addr (const \fBACE_TCHAR\fR * filename)
.PP
Create a ACE_FILE_Addr from a pathname.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS int ACE_FILE_Addr::addr_to_string (\fBACE_TCHAR\fR * addr, size_t) const\fC [virtual]\fR
.PP
Transform the current address into string format.
.PP
.SS void ACE_FILE_Addr::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_Addr\fR.
.SS void * ACE_FILE_Addr::get_addr (void) const\fC [virtual]\fR
.PP
Return a pointer to the address.
.PP
Reimplemented from \fBACE_Addr\fR.
.SS const \fBACE_TCHAR\fR * ACE_FILE_Addr::get_path_name (void) const
.PP
Return the path name used for the rendezvous point.
.PP
.SS int ACE_FILE_Addr::operator!= (const ACE_FILE_Addr & SAP) const
.PP
Compare two addresses for inequality.
.PP
.SS ACE_FILE_Addr & ACE_FILE_Addr::operator= (const ACE_FILE_Addr &)
.PP
Assignment operator.
.PP
.SS int ACE_FILE_Addr::operator== (const ACE_FILE_Addr & SAP) const
.PP
Compare two addresses for equality.
.PP
.SS int ACE_FILE_Addr::set (const \fBACE_TCHAR\fR * filename)
.PP
Create a ACE_FILE_Addr from a pathname.
.PP
.SS int ACE_FILE_Addr::set (const ACE_FILE_Addr & sa)
.PP
Acts like a copy constructor. If <sa> == \fBACE_Addr::sap_any\fR then create a temporary filename using .
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS ACE_FILE_Addr::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented from \fBACE_Addr\fR.
.SS \fBACE_TCHAR\fR ACE_FILE_Addr::filename_[MAXNAMLEN+1]\fC [private]\fR
.PP
Name of the file.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|