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
|
/* -*- C++ -*- */
//=============================================================================
/**
* @file FILE_Connector.h
*
* $Id$
*
* @author Doug Schmidt <schmidt@cs.wustl.edu>
*/
//=============================================================================
#ifndef ACE_FILE_CONNECTOR_H
#define ACE_FILE_CONNECTOR_H
#include "ace/pre.h"
#include "ace/FILE_IO.h"
#include "ace/Log_Msg.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
/**
* @class ACE_FILE_Connector
*
* @brief Defines an active connection factory for the ACE_FILE wrappers.
*
* Note that the O_APPEND flag is only partly supported on Win32. If
* you specify O_APPEND, then the file pointer will be positioned at
* the end of the file initially during open, but it is not
* re-positioned at the end prior to each write, as specified by
* POSIX. This is generally good enough for typical situations, but
* it is ``not quite right'' in its semantics.
*/
class ACE_Export ACE_FILE_Connector
{
public:
// = Initialization methods.
/// Default constructor.
ACE_FILE_Connector (void);
/**
* Actively ``connect'' and produce a <new_io> <ACE_FILE_IO> object
* if things go well. The <remote_sap> is the file that we are
* trying to create/open. If it's the default value of
* <ACE_Addr::sap_any> then the user is letting the OS create the
* filename (via <ACE_OS::mktemp>). The <timeout> is the amount of
* time to wait to create/open the file. If it's 0 then we block
* indefinitely. If *timeout == {0, 0} then the file is created
* using non-blocking mode. In this case, if the create/open can't
* be done immediately the value of -1 is returned with <errno ==
* EWOULDBLOCK>. If *timeout > {0, 0} then this is the maximum amount of
* time to wait before timing out. If the time expires before the
* connection is made <errno == ETIME>. The <local_sap> and
* <reuse_addr> parameters are ignored. The <flags> and <perms>
* arguments are passed down to the <ACE_OS::open> method.
*/
ACE_FILE_Connector (ACE_FILE_IO &new_io,
const ACE_FILE_Addr &remote_sap,
ACE_Time_Value *timeout = 0,
const ACE_Addr &local_sap = ACE_Addr::sap_any,
int reuse_addr = 0,
int flags = O_RDWR | O_CREAT,
int perms = ACE_DEFAULT_FILE_PERMS);
/**
* Actively ``connect'' and produce a <new_io> <ACE_FILE_IO> object
* if things go well. The <remote_sap> is the file that we are
* trying to create/open. If it's the default value of
* <ACE_Addr::sap_any> then the user is letting the OS create the
* filename (via <ACE_OS::mktemp>). The <timeout> is the amount of
* time to wait to create/open the file. If it's 0 then we block
* indefinitely. If *timeout == {0, 0} then the file is created
* using non-blocking mode. In this case, if the create/open can't
* be done immediately the value of -1 is returned with <errno ==
* EWOULDBLOCK>. If *timeout > {0, 0} then this is the maximum amount of
* time to wait before timing out. If the time expires before the
* connection is made <errno == ETIME>. The <local_sap> and
* <reuse_addr> parameters are ignored. The <flags> and <perms>
* arguments are passed down to the <ACE_OS::open> method.
*/
int connect (ACE_FILE_IO &new_io,
const ACE_FILE_Addr &remote_sap,
ACE_Time_Value *timeout = 0,
const ACE_Addr &local_sap = ACE_Addr::sap_any,
int reuse_addr = 0,
int flags = O_RDWR | O_CREAT,
int perms = ACE_DEFAULT_FILE_PERMS);
/// Resets any event associations on this handle
int reset_new_handle (ACE_HANDLE handle);
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
// = Meta-type "trait" information.
typedef ACE_FILE_Addr PEER_ADDR;
typedef ACE_FILE_IO PEER_STREAM;
};
#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/FILE_Connector.i"
#endif
#include "ace/post.h"
#endif /* ACE_FILE_CONNECTOR_H */
|
