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
|
.TH ACE_Stream_Tail 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Stream_Tail \- Standard module that acts as the head of a ustream.
.SH SYNOPSIS
.br
.PP
\fC#include <Stream_Modules.h>\fR
.PP
Inherits \fBACE_Task< ACE_SYNCH_USE >\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Stream_Tail\fR (void)"
.br
.RI "\fIConstruction.\fR"
.ti -1c
.RI "\fB~ACE_Stream_Tail\fR (void)"
.br
.RI "\fIDestruction.\fR"
.ti -1c
.RI "virtual int \fBopen\fR (void *a = 0)"
.br
.RI "\fIHook called to open a Task. can be used to pass arbitrary information into <open>.\fR"
.ti -1c
.RI "virtual int \fBclose\fR (u_long flags = 0)"
.br
.ti -1c
.RI "virtual int \fBput\fR (\fBACE_Message_Block\fR *msg, \fBACE_Time_Value\fR * = 0)"
.br
.RI "\fIA hook method that can be used to pass a message to a task, where it can be processed immediately or queued for subsequent processing in the <svc> hook method.\fR"
.ti -1c
.RI "virtual int \fBsvc\fR (void)"
.br
.RI "\fIRun by a daemon thread to handle deferred processing.\fR"
.ti -1c
.RI "virtual int \fBinit\fR (int argc, \fBACE_TCHAR\fR *argv[])"
.br
.RI "\fIInitializes object when dynamic linking occurs.\fR"
.ti -1c
.RI "virtual int \fBinfo\fR (\fBACE_TCHAR\fR **info_string, size_t length) \fBconst\fR"
.br
.RI "\fIReturns information on a service object.\fR"
.ti -1c
.RI "virtual int \fBfini\fR (void)"
.br
.RI "\fITerminates object when dynamic unlinking occurs.\fR"
.ti -1c
.RI "void \fBdump\fR (void) \fBconst\fR"
.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 Methods
.in +1c
.ti -1c
.RI "int \fBcontrol\fR (\fBACE_Message_Block\fR *)"
.br
.RI "\fIPerforms canonical flushing at the \fBACE_Stream\fR tail.\fR"
.ti -1c
.RI "int \fBcanonical_flush\fR (\fBACE_Message_Block\fR *)"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
.SS template<ACE_SYNCH_DECL> template class ACE_Stream_Tail
Standard module that acts as the head of a ustream.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS template<ACE_SYNCH_DECL> ACE_Stream_Tail<>::ACE_Stream_Tail<> (void)
.PP
Construction.
.PP
.SS template<ACE_SYNCH_DECL> ACE_Stream_Tail<>::~ACE_Stream_Tail<> (void)
.PP
Destruction.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS template<ACE_SYNCH_DECL> int ACE_Stream_Tail<>::canonical_flush (\fBACE_Message_Block\fR *)\fC [private]\fR
.PP
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::close (u_long flags = 0)\fC [virtual]\fR
.PP
Hook called from when during thread exit and from the default implemenation of <module_closed>. In general, this method shouldn't be called directly by an application, particularly if the <Task> is running as an Active Object. Instead, a special message should be passed into the <Task> via the <put> method defined below, and the <svc> method should interpret this as a flag to shut down the <Task>.
.PP
Reimplemented from \fBACE_Task_Base\fR.
.SS template<ACE_SYNCH_DECL> int ACE_Stream_Tail<>::control (\fBACE_Message_Block\fR *)\fC [private]\fR
.PP
Performs canonical flushing at the \fBACE_Stream\fR tail.
.PP
.SS template<ACE_SYNCH_DECL> void ACE_Stream_Tail<>::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_Task\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::fini (void)\fC [virtual]\fR
.PP
Terminates object when dynamic unlinking occurs.
.PP
Reimplemented from \fBACE_Shared_Object\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::info (\fBACE_TCHAR\fR ** info_string, size_t length) const\fC [virtual]\fR
.PP
Returns information on a service object.
.PP
Reimplemented from \fBACE_Shared_Object\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::init (int argc, \fBACE_TCHAR\fR * argv[])\fC [virtual]\fR
.PP
Initializes object when dynamic linking occurs.
.PP
Reimplemented from \fBACE_Shared_Object\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::open (void * a = 0)\fC [virtual]\fR
.PP
Hook called to open a Task. can be used to pass arbitrary information into <open>.
.PP
Reimplemented from \fBACE_Task_Base\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::put (\fBACE_Message_Block\fR * msg, \fBACE_Time_Value\fR * timeout = 0)\fC [virtual]\fR
.PP
A hook method that can be used to pass a message to a task, where it can be processed immediately or queued for subsequent processing in the <svc> hook method.
.PP
Reimplemented from \fBACE_Task_Base\fR.
.SS template<ACE_SYNCH_DECL> virtual int ACE_Stream_Tail<>::svc (void)\fC [virtual]\fR
.PP
Run by a daemon thread to handle deferred processing.
.PP
Reimplemented from \fBACE_Task_Base\fR.
.SH MEMBER DATA DOCUMENTATION
.PP
.SS template<ACE_SYNCH_DECL> ACE_Stream_Tail<>::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented from \fBACE_Task\fR.
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
