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
|
.TH ACE_Asynch_Write_Dgram 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Asynch_Write_Dgram \- This class is a factory for starting off asynchronous writes on a UDP socket. This class forwards all methods to its implementation class.
.SH SYNOPSIS
.br
.PP
\fC#include <Asynch_IO.h>\fR
.PP
Inherits \fBACE_Asynch_Operation\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Asynch_Write_Dgram\fR (void)"
.br
.RI "\fIA do nothing constructor.\fR"
.ti -1c
.RI "virtual \fB~ACE_Asynch_Write_Dgram\fR (void)"
.br
.RI "\fIDestructor.\fR"
.ti -1c
.RI "int \fBopen\fR (\fBACE_Handler\fR &handler, ACE_HANDLE handle = ACE_INVALID_HANDLE, const void *completion_key = 0, \fBACE_Proactor\fR *proactor = 0)"
.br
.ti -1c
.RI "\fBssize_t\fR \fBsend\fR (\fBACE_Message_Block\fR *message_block, size_t &number_of_bytes_sent, int flags, const \fBACE_Addr\fR& remote_addr, const void *act = 0, int priority = 0, int signal_number = ACE_SIGRTMIN)"
.br
.ti -1c
.RI "\fBACE_Asynch_Write_Dgram_Impl\fR* \fBimplementation\fR (void) const"
.br
.RI "\fIReturn the underlying implementation class.\fR"
.in -1c
.SS Protected Methods
.in +1c
.ti -1c
.RI "void \fBimplementation\fR (\fBACE_Asynch_Write_Dgram_Impl\fR *implementation)"
.br
.RI "\fISet the implementation class.\fR"
.in -1c
.SS Protected Attributes
.in +1c
.ti -1c
.RI "\fBACE_Asynch_Write_Dgram_Impl\fR* \fBimplementation_\fR"
.br
.RI "\fIImplementation class that all methods will be forwarded to.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
This class is a factory for starting off asynchronous writes on a UDP socket. This class forwards all methods to its implementation class.
.PP
.PP
Once <open> is called, multiple asynchronous <writes>s can started using this class. An \fBACE_Asynch_Write_Dgram::Result\fR will be passed back to the <handler> when the asynchronous write completes through the callback.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Asynch_Write_Dgram::ACE_Asynch_Write_Dgram (void)
.PP
A do nothing constructor.
.PP
.SS ACE_Asynch_Write_Dgram::~ACE_Asynch_Write_Dgram (void)\fC [virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS void ACE_Asynch_Write_Dgram::implementation (\fBACE_Asynch_Write_Dgram_Impl\fR * implementation)\fC [protected]\fR
.PP
Set the implementation class.
.PP
.SS \fBACE_Asynch_Write_Dgram_Impl\fR * ACE_Asynch_Write_Dgram::implementation (void) const
.PP
Return the underlying implementation class.
.PP
Reimplemented from \fBACE_Asynch_Operation\fR.
.SS int ACE_Asynch_Write_Dgram::open (\fBACE_Handler\fR & handler, ACE_HANDLE handle = ACE_INVALID_HANDLE, const void * completion_key = 0, \fBACE_Proactor\fR * proactor = 0)
.PP
Initializes the factory with information which will be used with each asynchronous call. If (<handle> == ACE_INVALID_HANDLE), will be called on the <handler> to get the correct handle.
.PP
Reimplemented from \fBACE_Asynch_Operation\fR.
.SS \fBssize_t\fR ACE_Asynch_Write_Dgram::send (\fBACE_Message_Block\fR * message_block, size_t & number_of_bytes_sent, int flags, const \fBACE_Addr\fR & remote_addr, const void * act = 0, int priority = 0, int signal_number = ACE_SIGRTMIN)
.PP
This starts off an asynchronous send. Upto <message_block->total_length()> will be sent. <message_block>'s <rd_ptr> will be updated to reflect the sent bytes if the send operation is successfully completed. Return code of 1 means immediate success and <number_of_bytes_sent> is updated to number of bytes sent. The method will still be called. Return code of 0 means the IO will complete proactively. Return code of -1 means there was an error, use errno to get the error code.
.PP
Scatter/gather is supported on WIN32 by using the <message_block->cont()> method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto <message_block->length()> bytes will be sent from each <message block> for a total of <message_block->total_length()> bytes. All <message_block>'s <rd_ptr>'s will be updated to reflect the bytes sent from each <message_block>.
.PP
Priority of the operation is specified by <priority>. On POSIX4-Unix, this is supported. Works like <nice> in Unix. Negative values are not allowed. 0 means priority of the operation same as the process priority. 1 means priority of the operation is one less than process. And so forth. On Win32, this argument is a no-op. <signal_number> is the POSIX4 real-time signal number to be used for the operation. <signal_number> ranges from ACE_SIGRTMIN to ACE_SIGRTMAX. This argument is a no-op on non-POSIX4 systems.
.SH MEMBER DATA DOCUMENTATION
.PP
.SS \fBACE_Asynch_Write_Dgram_Impl\fR * ACE_Asynch_Write_Dgram::implementation_\fC [protected]\fR
.PP
Implementation class that all methods will be forwarded to.
.PP
Reimplemented from \fBACE_Asynch_Operation\fR.
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
