File: tcpstream.3cc

package info (click to toggle)
libcommoncpp2 1.0.13-5
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,740 kB
  • ctags: 2,860
  • sloc: cpp: 18,857; sh: 8,451; ansic: 1,546; makefile: 299; xml: 5
file content (133 lines) | stat: -rw-r--r-- 3,220 bytes parent folder | download
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
.TH "tcpstream" 3 "19 Jul 2003" "CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
tcpstream \- A more natural C++ 'tcpstream' class for use by non-threaded applications. C++ 'fstream' style tcpstream class. 
.SH SYNOPSIS
.br
.PP
\fC#include <socket.h>\fP
.PP
Inherits \fBTCPStream\fP.
.PP
Inherited by \fBiftpstream\fP, and \fBoftpstream\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBtcpstream\fP (const tcpstream &rhs)"
.br
.ti -1c
.RI "\fBtcpstream\fP ()"
.br
.RI "\fIConstruct an unopened 'tcpstream' object.\fP"
.ti -1c
.RI "\fBtcpstream\fP (const char *addr, int buffer=512)"
.br
.RI "\fIConstruct and 'open' (connect) the tcp stream to a remote socket.\fP"
.ti -1c
.RI "\fBtcpstream\fP (\fBTCPSocket\fP &tcp, int buffer=512)"
.br
.RI "\fIConstruct and 'accept' (connect) the tcp stream through a server.\fP"
.ti -1c
.RI "void \fBopen\fP (const char *addr, int buffer=512)"
.br
.RI "\fIOpen a tcp stream connection.\fP"
.ti -1c
.RI "void \fBopen\fP (\fBTCPSocket\fP &tcp, int buffer=512)"
.br
.RI "\fIOpen a tcp stream connection by accepting a tcp socket.\fP"
.ti -1c
.RI "void \fBclose\fP (void)"
.br
.RI "\fIClose the active tcp stream connection.\fP"
.ti -1c
.RI "bool \fBoperator!\fP () const"
.br
.RI "\fITest to see if stream is open.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
A more natural C++ 'tcpstream' class for use by non-threaded applications. C++ 'fstream' style tcpstream class.
.PP
This class behaves a lot more like fstream and similar classes.
.PP
\fBAuthor: \fP
.in +1c
David Sugar <dyfet@ostel.com> 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "tcpstream::tcpstream (const tcpstream & rhs)\fC [inline]\fP"
.PP
.SS "tcpstream::tcpstream ()"
.PP
Construct an unopened 'tcpstream' object.
.PP
.SS "tcpstream::tcpstream (const char * addr, int buffer = 512)"
.PP
Construct and 'open' (connect) the tcp stream to a remote socket.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
string address in form addr:port. 
.TP
\fB\fIbuffer\fP\fP
size for streaming (optional). 
.SS "tcpstream::tcpstream (\fBTCPSocket\fP & tcp, int buffer = 512)"
.PP
Construct and 'accept' (connect) the tcp stream through a server.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fItcp\fP\fP
socket to accept from. 
.TP
\fB\fIbuffer\fP\fP
size for streaming (optional). 
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "void tcpstream::close (void)"
.PP
Close the active tcp stream connection.
.PP
Reimplemented in \fBoftpstream\fP, and \fBiftpstream\fP.
.SS "void tcpstream::open (\fBTCPSocket\fP & tcp, int buffer = 512)"
.PP
Open a tcp stream connection by accepting a tcp socket.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fItcp\fP\fP
socket to accept from. 
.TP
\fB\fIbuffer\fP\fP
size for streaming (optional) 
.SS "void tcpstream::open (const char * addr, int buffer = 512)"
.PP
Open a tcp stream connection.
.PP
This will close the currently active connection first.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
string address in form addr:port. 
.TP
\fB\fIbuffer\fP\fP
size for streaming (optional) 
.SS "bool tcpstream::operator! ()"
.PP
Test to see if stream is open.
.PP
Reimplemented from \fBSocket\fP.

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for CommonC++ from the source code.