File: Socket.hh

package info (click to toggle)
3dwm 0.3.1-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,368 kB
  • ctags: 2,547
  • sloc: cpp: 11,981; sh: 7,850; ansic: 851; makefile: 287; yacc: 135; lex: 92
file content (197 lines) | stat: -rw-r--r-- 4,772 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* ------------------------------------------------------------------------
 * $Id: Socket.hh,v 1.5 2001/06/29 15:00:38 elm Exp $
 *
 * This file is part of 3Dwm: The Three-Dimensional User Environment.
 *
 * 3Dwm: The Three-Dimensional User Environment:
 *	<http://www.3dwm.org>
 *
 * Chalmers Medialab
 * 	<http://www.medialab.chalmers.se>
 * 
 * ------------------------------------------------------------------------
 * File created 2000-09-23 by Niklas Elmqvist.
 *
 * Copyright (c) 2000 Niklas Elmqvist <elm@3dwm.org>.
 * ------------------------------------------------------------------------
 * 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; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * ------------------------------------------------------------------------
 */

#ifndef _Socket_hh_
#define _Socket_hh_

// -- System Includes
#include <netinet/in.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <utility>

// -- Class Declarations

/**
 * Socket address abstract base class.
 **/
class Address {
public:
    
    int getType() const { return _type; }
    virtual const sockaddr *getAddr() const = 0;
    virtual int getAddrLen() const = 0;

protected:

    Address() : _type(AF_INET) { }
    Address(int type) : _type(type) { }
    virtual ~Address() { }
    
private:
    int _type;
};

class InetAddress : public Address {
public:
    
    InetAddress(int port);
    InetAddress(const sockaddr_in &sin);
    InetAddress(const char *host, int port);
    
    const sockaddr *getAddr() const { return (sockaddr *) &_sin; }
    int getAddrLen() const { return sizeof(_sin); }

private:
    sockaddr_in _sin;
};

/**
 * Simple socket abstraction class. Wraps BSD Sockets in a cleaner,
 * easy-to-use interface.
 **/
class Socket {

public:
    
    /**
     * Default constructor.
     * 
     * @param protocol the protocol type.
     **/
    Socket(int protocol = AF_INET);

    /**
     * Constructor.
     *
     * @param fd an opened file descriptor to use.
     * @param protocol the protocol type.
     **/
    Socket(int fd, int protocol);

    /**
     * Copy constructor.
     **/
    Socket(const Socket &s);
    
    /**
     * Destructor.
     **/
    virtual ~Socket();

    /**
     * Connect the socket to a given address.
     * 
     * @param addr the address of the host to connect to.
     **/ 
    void connect(const Address &addr);
    
    /**
     * Send data over the socket.
     *
     * @param data the data buffer to send.
     * @param len the number of bytes to send.
     * @return the number of bytes actually sent.
     **/
    int send(const void *data, int len);
    
    /**
     * Receive data from the socket.
     *
     * @param data the data buffer to store the received info in.
     * @param len the length of the data buffer.
     * @return the number of bytes actually received.
     **/
    int receive(void *data, int len);

    /**
     * Shutdown the socket.
     **/
    void shutdown(bool norecv = true, bool nosend = true);

    /**
     * Close the socket.
     **/
    void close();
    
    /**
     * Start listening for connections on a socket.
     *
     * @param int backlog the maximum number of queued connections.
     **/
    void listen(int backlog);

    /**
     * Accept an incoming connection to the socket.
     * 
     * @return a pair of the new socket and the client address.
     **/
    std::pair<Socket *, Address *> accept(); 

    /**
     * Bind the socket to an address.
     *
     * @param addr the address to bind the socket to. 
     **/
    void bind(const Address &addr);

    /**
     * Set socket to be nonblocking. 
     **/ 
    void setNonblocking();

    /**
     * Retrieve socket protocol type.
     *
     * @return the protocol type.
     **/ 
    int getProtocol() const { return _protocol; }

    /**
     * Is the remote peer located on the same host as this socket?
     * 
     * @return true if the peer and socket are colocated.
     **/
    bool isSameHost() const;
    
protected:

    // Socket file descriptor
    int _socket;

    // Protocol type
    int _protocol;
};

#endif /* socket.hh */