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
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// SOCK_Stream.h
//
// = AUTHOR
// Doug Schmidt
//
// ============================================================================
#ifndef ACE_SOCK_STREAM_H
#define ACE_SOCK_STREAM_H
#include "ace/SOCK_IO.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/INET_Addr.h"
class ACE_Export ACE_SOCK_Stream : public ACE_SOCK_IO
{
// = TITLE
// Defines the methods in the <ACE_SOCK_Stream> abstraction.
//
// = DESCRIPTION
// This adds additional wrapper methods atop the <ACE_SOCK_IO>
// class.
public:
// Initialization and termination methods.
ACE_SOCK_Stream (void);
// Constructor.
ACE_SOCK_Stream (ACE_HANDLE h);
// Constructor (sets the underlying <ACE_HANDLE> with <h>).
~ACE_SOCK_Stream (void);
// Destructor.
//= The following two methods use write and read system calls.
ssize_t send_n (const void *buf, int n) const;
// Send n bytes, keep trying until n are sent.
ssize_t recv_n (void *buf, int n) const;
// Recv n bytes, keep trying until n are received.
// = The following two methods use the send and recv system calls.
ssize_t send_n (const void *buf, int n, int flags) const;
// Send n bytes, keep trying until n are sent.
ssize_t recv_n (void *buf, int n, int flags) const;
// Recv n bytes, keep trying until n are received.
ssize_t send_n (const void *buf,
size_t len,
int flags,
const ACE_Time_Value *timeout);
// Try to send exactly <len> bytes into <buf> from <handle> (uses
// the <send> call). If <send> blocks for longer than <timeout> the
// number of bytes actually sent is returned with <errno == ETIME>.
// If a timeout does not occur, <send_n> return <len> (i.e., the
// number of bytes requested to be sent).
ssize_t recv_n (void *buf,
size_t len,
int flags,
const ACE_Time_Value *timeout);
// Try to recv exactly <len> bytes into <buf> from <handle> (uses
// the <ACE::recv_n> call). The <ACE_Time_Value> indicates how long
// to blocking trying to receive. If <timeout> == 0, the caller
// will block until action is possible, else will wait until the
// relative time specified in *<timeout> elapses). If <recv> blocks
// for longer than <timeout> the number of bytes actually read is
// returned with <errno == ETIME>. If a timeout does not occur,
// <recv_n> return <len> (i.e., the number of bytes requested to be
// read).
ssize_t sendv_n (const iovec iov[],
size_t n) const;
// Send an <iovec> of size <n> to the connected socket (uses
// <ACE::sendv_n>). Will block until all bytes are sent or an error
// occurs.
ssize_t recvv_n (iovec iov[],
size_t n) const;
// Receive an <iovec> of size <n> to the connected socket.
// = Send/receive an ``urgent'' character (see TCP specs...).
ssize_t send_urg (void *ptr, int len = sizeof (char));
ssize_t recv_urg (void *ptr, int len = sizeof (char));
// = Selectively close endpoints.
int close_reader (void);
// Close down the reader.
int close_writer (void);
// Close down the writer.
int close (void);
// Close down the socket (we need this to make things work correctly
// on Win32, which requires use to do a <close_writer> before doing
// the close to avoid losing data).
// = Meta-type info
typedef ACE_INET_Addr PEER_ADDR;
void dump (void) const;
// Dump the state of an object.
ACE_ALLOC_HOOK_DECLARE;
// Declare the dynamic allocation hooks.
};
#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/SOCK_Stream.i"
#endif
#endif /* ACE_SOCK_STREAM_H */
|
