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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
//
// socketstream.h
//
// this file contains the wrappers that can be used
// as a iostream-compatible TCP/IP sockets
//
// on Windows the program that uses this utility
// should be linked with Ws2_32.lib
//
// Copyright (C) 2001 Maciej Sobczak
//
// you can use this code for any purpose without limitations
// (and for your own risk) as long as this notice remains
//
#ifndef SOCKETSTREAMS_H
#define SOCKETSTREAMS_H
#include "imcfg.h"
#ifndef WIN32_NOTCYGWIN
// this is for Unix
#include <unistd.h>
#include <sys/un.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <cerrno>
#include <netdb.h>
#include <arpa/inet.h>
#define INVALID_SOCKET -1
#define SOCKET_ERROR -1
#ifndef INADDR_NONE
# define INADDR_NONE ((in_addr_t) 0xffffffff)
#endif
#else
// this is for MS Windows
#include <winsock.h>
typedef int socklen_t;
#endif
#include <string>
/* old guard pseudo standard library */
#if (defined(__GNUC__) && (__GNUC__ < 3))
# include <streambuf.h>
#else
# include <streambuf>
#endif
#include <iostream>
#include <stdexcept>
using std::streambuf;
using std::iostream;
// exception class which designates errors from socket functions
class SocketRunTimeException : public std::runtime_error
{
public:
explicit SocketRunTimeException(const std::string &what);
virtual const char * what() const throw();
int errornumber() const throw() { return errnum; }
~SocketRunTimeException() throw () { }
private:
// this will serve as a message returned from what()
mutable std::string msg;
int errnum;
};
// exception class which designates logic (programming) errors with sockets
class SocketLogicException : public std::logic_error
{
public:
explicit SocketLogicException(const std::string &what)
: std::logic_error(what)
{
}
};
// this class serves as a socket wrapper
class TCPSocketWrapper
{
#ifdef WIN32_NOTCYGWIN
// on Windows, socket is represented by the opaque handler
typedef SOCKET socket_type;
#else
// on Linux, socket is just a descriptor number
typedef int socket_type;
#endif
// proxy helper for syntax:
// Sock s2(s1.accept());
class TCPAcceptedSocket
{
private:
TCPAcceptedSocket(socket_type s, sockaddr_in a);
// copy not provided for the proxy
TCPAcceptedSocket(const TCPAcceptedSocket &) {}
TCPAcceptedSocket& operator=(const TCPAcceptedSocket &) {}
socket_type sock;
sockaddr_in addr;
friend class TCPSocketWrapper;
};
public:
enum sockstate_type { CLOSED, LISTENING, ACCEPTED, CONNECTED };
TCPSocketWrapper();
~TCPSocketWrapper();
// this is provided for syntax
// TCPSocketWrapper s2(s2.accept());
TCPSocketWrapper(const TCPAcceptedSocket &as);
// server methods
// binds and listens on a given port number
void listen(int port, int backlog = 100);
// accepts the new connection
// it requires the earlier call to listen
TCPAcceptedSocket accept();
// client methods
// creates the new connection
void connect(const char *address, int port);
// general methods
// get the current state of the socket wrapper
sockstate_type state() const { return sockstate; }
// get the network address and port number of the socket
const char * address() const;
int port() const;
// write data to the socket
void write(const void *buf, int len);
// read data from the socket
// returns the number of bytes read
int read(void *buf, int len);
void close();
private:
// not for use
TCPSocketWrapper(const TCPSocketWrapper&);
TCPSocketWrapper& operator=(const TCPSocketWrapper&);
socket_type sock;
sockaddr_in sockaddress;
sockstate_type sockstate;
};
#ifdef HAVE_STANDARD_CHAR_TRAITS
// this class is supposed to serve as a stream buffer associated with a socket
template <class charT, class traits = std::char_traits <charT> >
class TCPStreamBuffer : public std::basic_streambuf<charT, traits>
{
typedef std::basic_streambuf<charT, traits> sbuftype;
typedef typename sbuftype::int_type int_type;
typedef charT char_type;
public:
// the buffer will take ownership of the socket (ie. it will close it
// in the destructor) if takeowner == true
explicit TCPStreamBuffer(TCPSocketWrapper &sock,
bool takeowner = false, std::streamsize bufsize = 512)
: rsocket_(sock), ownsocket_(takeowner),
bufsize_(bufsize), inbuf_(NULL), outbuf_(NULL),
remained_(0), ownbuffers_(false)
{
}
~TCPStreamBuffer()
{
if (rsocket_.state() == TCPSocketWrapper::CONNECTED ||
rsocket_.state() == TCPSocketWrapper::ACCEPTED)
_flush();
if (ownbuffers_)
{
delete [] inbuf_;
delete [] outbuf_;
}
if (ownsocket_ == true)
rsocket_.close();
}
protected:
sbuftype * setbuf(char_type *s, std::streamsize n)
{
if (this->gptr() == NULL)
{
this->setg(s, s + n, s + n);
this->setp(s, s + n);
inbuf_ = s;
outbuf_ = s;
bufsize_ = n;
ownbuffers_ = false;
}
return this;
}
void _flush()
{
rsocket_.write(outbuf_, (this->pptr() - outbuf_) * sizeof(char_type));
}
int_type overflow(int_type c = traits::eof())
{
// this method is supposed to flush the put area of the buffer
// to the I/O device
// if the buffer was not already allocated nor set by user,
// do it just now
if (this->pptr() == NULL)
{
outbuf_ = new char_type[bufsize_];
ownbuffers_ = true;
}
else
{
_flush();
}
this->setp(outbuf_, outbuf_ + bufsize_);
if (c != traits::eof())
this->sputc(traits::to_char_type(c));
return 0;
}
int sync()
{
// just flush the put area
_flush();
this->setp(outbuf_, outbuf_ + bufsize_);
return 0;
}
int_type underflow()
{
// this method is supposed to read some bytes from the I/O device
// if the buffer was not already allocated nor set by user,
// do it just now
if (this->gptr() == NULL)
{
inbuf_ = new char_type[bufsize_];
ownbuffers_ = true;
}
if (remained_ != 0)
inbuf_[0] = remainedchar_;
int readn = rsocket_.read(static_cast<char*>(inbuf_) + remained_,
bufsize_ * sizeof(char_type) - remained_);
// if (readn == 0 && remained_ != 0)
// error - there is not enough bytes for completing
// the last character before the end of the stream
// - this can mean error on the remote end
if (readn == 0)
return traits::eof();
int totalbytes = readn + remained_;
this->setg(inbuf_, inbuf_,
inbuf_ + totalbytes / sizeof(char_type));
remained_ = totalbytes % sizeof(char_type);
if (remained_ != 0)
remainedchar_ = inbuf_[totalbytes / sizeof(char_type)];
return this->sgetc();
}
private:
// not for use
TCPStreamBuffer(const TCPStreamBuffer&);
TCPStreamBuffer& operator=(const TCPStreamBuffer&);
TCPSocketWrapper &rsocket_;
bool ownsocket_;
std::streamsize bufsize_;
char_type *inbuf_;
char_type *outbuf_;
int remained_;
char_type remainedchar_;
bool ownbuffers_;
};
// this class is an ultimate stream associated with a socket
template <class charT, class traits = std::char_traits<charT> >
class TCPGenericStream :
private TCPStreamBuffer<charT, traits>,
public std::basic_iostream<charT, traits>
{
public:
// this constructor takes 'ownership' of the socket wrapper if btakeowner == true,
// so that the socket will be closed in the destructor of the
// TCPStreamBuffer object
explicit TCPGenericStream(TCPSocketWrapper &sock, bool takeowner = false)
: TCPStreamBuffer<charT, traits>(sock, takeowner),
std::basic_iostream<charT, traits>(this)
{
}
private:
// not for use
TCPGenericStream(const TCPGenericStream&);
TCPGenericStream& operator=(const TCPGenericStream&);
};
// this is even more specialized for use as a client
template <class charT, class traits = std::char_traits<charT> >
class TCPGenericClientStream :
private TCPSocketWrapper,
public TCPGenericStream<charT, traits>
{
public:
TCPGenericClientStream(const char *address, int port)
: TCPGenericStream<charT, traits>(*this, false)
{
TCPSocketWrapper::connect(address, port);
}
private:
// not for use
TCPGenericClientStream(const TCPGenericClientStream&);
TCPGenericClientStream& operator=(const TCPGenericClientStream&);
};
// helper declarations for narrow and wide streams
typedef TCPGenericStream<char> TCPStream;
typedef TCPGenericStream<wchar_t> TCPWStream;
typedef TCPGenericClientStream<char> TCPClientStream;
typedef TCPGenericClientStream<wchar_t> TCPWClientStream;
#else // HAVE_STANDARD_CHAR_TRAITS
// NO TRAITS HERE, Hmmkeay?
// narrow stream buffer only.
// this class is supposed to serve as a stream buffer associated with a socket
class TCPStreamBuffer : public streambuf
{
typedef streambuf sbuftype;
typedef int int_type;
typedef char char_type;
public:
// the buffer will take ownership of the socket (ie. it will close it
// in the destructor) if takeowner == true
explicit TCPStreamBuffer(TCPSocketWrapper &sock,
bool takeowner = false, std::streamsize bufsize = 512)
: rsocket_(sock), ownsocket_(takeowner),
bufsize_(bufsize), inbuf_(NULL), outbuf_(NULL),
remained_(0), ownbuffers_(false)
{
}
~TCPStreamBuffer()
{
if (rsocket_.state() == TCPSocketWrapper::CONNECTED ||
rsocket_.state() == TCPSocketWrapper::ACCEPTED)
_flush();
if (ownbuffers_)
{
delete [] inbuf_;
delete [] outbuf_;
}
if (ownsocket_ == true)
rsocket_.close();
}
protected:
sbuftype * setbuf(char_type *s, std::streamsize n)
{
if (gptr() == NULL)
{
setg(s, s + n, s + n);
setp(s, s + n);
inbuf_ = s;
outbuf_ = s;
bufsize_ = n;
ownbuffers_ = false;
}
return this;
}
void _flush()
{
rsocket_.write(outbuf_, (pptr() - outbuf_) * sizeof(char_type));
}
int sync()
{
// just flush the put area
_flush();
setp(outbuf_, outbuf_ + bufsize_);
return 0;
}
private:
// not for use
TCPStreamBuffer(const TCPStreamBuffer&);
TCPStreamBuffer& operator=(const TCPStreamBuffer&);
TCPSocketWrapper &rsocket_;
bool ownsocket_;
std::streamsize bufsize_;
char_type *inbuf_;
char_type *outbuf_;
int remained_;
char_type remainedchar_;
bool ownbuffers_;
};
// this class is an ultimate stream associated with a socket
class TCPGenericStream :
private TCPStreamBuffer,
public iostream
{
public:
// this constructor takes 'ownership' of the socket wrapper if btakeowner == true,
// so that the socket will be closed in the destructor of the
// TCPStreamBuffer object
explicit TCPGenericStream(TCPSocketWrapper &sock, bool takeowner = false)
: TCPStreamBuffer(sock, takeowner),
iostream(this)
{
}
private:
// not for use
TCPGenericStream(const TCPGenericStream&);
TCPGenericStream& operator=(const TCPGenericStream&);
};
// this is even more specialized for use as a client
class TCPGenericClientStream :
private TCPSocketWrapper,
public TCPGenericStream
{
public:
TCPGenericClientStream(const char *address, int port)
: TCPGenericStream(*this, false)
{
TCPSocketWrapper::connect(address, port);
}
private:
// not for use
TCPGenericClientStream(const TCPGenericClientStream&);
TCPGenericClientStream& operator=(const TCPGenericClientStream&);
};
// helper declarations for narrow streams
typedef TCPGenericStream TCPStream;
typedef TCPGenericClientStream TCPClientStream;
// no possibility of wide stream with this reduced STL version
#endif // HAVE_STANDARD_CHAR_TRAITS
// 'portable' code should call those on the beginning and end of the program
// (Linux/Unix code does not require any initialization and cleanup)
bool socketsInit(); // returns true in success
void socketsEnd();
#endif // SOCKETSTREAMS
|