summaryrefslogtreecommitdiffstats
path: root/pki/base/tps/src/include/httpClient/httpc/Socket.h
blob: c2ef4afd4c3c8f2f00622e70632566da1dfa3d00 (plain)
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
150
151
152
153
154
155
156
157
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 */
/** BEGIN COPYRIGHT BLOCK
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301  USA 
 * 
 * Copyright (C) 2007 Red Hat, Inc.
 * All rights reserved.
 * END COPYRIGHT BLOCK **/

#ifndef __SOCKET_H
#define __SOCKET_H

#ifdef HAVE_CONFIG_H
#ifndef AUTOTOOLS_CONFIG_H
#define AUTOTOOLS_CONFIG_H

/* Eliminate warnings when using Autotools */
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION

#include <config.h>
#endif /* AUTOTOOLS_CONFIG_H */
#endif /* HAVE_CONFIG_H */

/**
 * Socket.h	1.000 06/12/2002
 * 
 * A NSPR implementation of socket
 *
 * @author  Surendra Rajam
 * @version 1.000, 06/12/2002
 */

class EXPORT_DECL Socket {
	friend class ServerSocket;
	friend class ServerConnection;
public:
	
	/**
	 * Constructor 
	 */
	Socket();

	/**
	 * Constructor - creates a socket connecting to the host and port
	 *
	 * @param	host	hostname to connect to
	 * @param	port	port of the machine
	 */
	Socket(const char* host, int port);

	/**
	 * Destructor
	 */
	virtual ~Socket();

public:

	/**
	 * Reads specified number of bytes from the socket. This is a blocking
	 * socket read with timeout.
	 *
	 * @param	buf		buffer to read into
	 * @param	size	number of bytes to read
	 * @param	timeout	timeout before the read terminates
	 * @return			number of bytes actually read
	 */
	int Read(void* buf, int size, long timeout);

	/**
	 * Writes specified number of bytes to the socket. This is a blocking
	 * socket write with timeout.
	 *
	 * @param	buf		buffer to write from
	 * @param	size	number of bytes to write
	 * @param	timeout	timeout before the write terminates
	 * @return			number of bytes actually written
	 */
	int Write(void* buf, int size, long timeout);

	/**
	 * Gets ip address for a specified socket
	 *
	 * @return	ip address
	 */
	const char* GetLocalIp();

	/**
	 * Gets port for a specified socket
	 *
	 * @return	port
	 */
	int GetLocalPort();

	/**
	 * Gets ip address of a connected peer
	 *
	 * @return	ip address
	 */
	const char* GetPeerIp();

	/**
	 * Gets port of a connected peer
	 *
	 * @return	ip address
	 */
	int GetPeerPort();

	/**
	 * Shuts down part of a full-duplex connection on a specified socket
	 *
	 * @param	how		the kind of disallowed operations on the socket
	 *					the possible values are :
	 *					PR_SHUTDOWN_RCV
	 *					PR_SHUTDOWN_SEND
	 *					PR_SHUTDOWN_BOTH
	 */
	void Shutdown(PRShutdownHow how);

protected:
	int Init(PRFileDesc* fd);

private:
	void CancelIO(PRInt32 err);

protected:
	PRFileDesc* m_fd;

private:
	char* m_localIp;
	char* m_peerIp;
	int m_localPort;
	int m_peerPort;
	bool m_initialized;
	PRLock* m_readLock;
	PRLock* m_writeLock;
};

#endif // __SOCKET_H