generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-10-28 11:31:53 +01:00
Code Issues Projects Releases Wiki Activity

add PollSet class (backported from develop)

Browse Source
This commit is contained in:
Guenter Obiltschnig
2017-11-01 11:19:52 +01:00
parent 44c3e8f22b
commit 341aed39fe
8 changed files with 836 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
Net/include/Poco/Net/PollSet.h Normal file
View File

@@ -0,0 +1,86 @@
//
// PollSet.h
//
// Library: Net
// Package: Sockets
// Module: PollSet
//
// Definition of the PollSet class.
//
// Copyright (c) 2016, Applied Informatics Software Engineering GmbH.
// All rights reserved.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Net_PollSet_INCLUDED
#define Net_PollSet_INCLUDED
#include "Poco/Net/Socket.h"
#include <map>
namespace Poco {
namespace Net {
class PollSetImpl;
class Net_API PollSet
/// A set of sockets that can be efficiently polled as a whole.
///
/// If supported, PollSet is implemented using epoll (Linux) or
/// poll (BSD) APIs. A fallback implementation using select()
/// is also provided.
{
public:
enum Mode
{
POLL_READ = 0x01,
POLL_WRITE = 0x02,
POLL_ERROR = 0x04
};
typedef std::map<Poco::Net::Socket, int> SocketModeMap;
PollSet();
/// Creates an empty PollSet.
~PollSet();
/// Destroys the PollSet.
void add(const Poco::Net::Socket& socket, int mode);
/// Adds the given socket to the set, for polling with
/// the given mode, which can be an OR'd combination of
/// POLL_READ, POLL_WRITE and POLL_ERROR.
void remove(const Poco::Net::Socket& socket);
/// Removes the given socket from the set.
void update(const Poco::Net::Socket& socket, int mode);
/// Updates the mode of the given socket.
void clear();
/// Removes all sockets from the PollSet.
SocketModeMap poll(const Poco::Timespan& timeout);
/// Waits until the state of at least one of the PollSet's sockets
/// changes accordingly to its mode, or the timeout expires.
/// Returns a PollMap containing the sockets that have had
/// their state changed.
private:
PollSetImpl* _pImpl;
PollSet(const PollSet&);
PollSet& operator = (const PollSet&);
};
} } // namespace Poco::Net
#endif // Net_PollSet_INCLUDED

109
Net/include/Poco/Net/SocketImpl.h
View File

@@ -31,7 +31,7 @@ namespace Net {
class Net_API SocketImpl: public Poco::RefCountedObject
/// This class encapsulates the Berkeley sockets API.
///
///
/// Subclasses implement specific socket types like
/// stream or datagram sockets.
///
@@ -56,9 +56,9 @@ public:
/// with the client.
///
/// The client socket's address is returned in clientAddr.
virtual void connect(const SocketAddress& address);
/// Initializes the socket and establishes a connection to
/// Initializes the socket and establishes a connection to
/// the TCP server at the given address.
///
/// Can also be used for UDP sockets. In this case, no
@@ -66,14 +66,14 @@ public:
/// packets are restricted to the specified address.
virtual void connect(const SocketAddress& address, const Poco::Timespan& timeout);
/// Initializes the socket, sets the socket timeout and
/// Initializes the socket, sets the socket timeout and
/// establishes a connection to the TCP server at the given address.
virtual void connectNB(const SocketAddress& address);
/// Initializes the socket and establishes a connection to
/// Initializes the socket and establishes a connection to
/// the TCP server at the given address. Prior to opening the
/// connection the socket is set to nonblocking mode.
virtual void bind(const SocketAddress& address, bool reuseAddress = false);
/// Bind a local address to the socket.
///
@@ -149,14 +149,14 @@ public:
virtual void shutdownReceive();
/// Shuts down the receiving part of the socket connection.
virtual void shutdownSend();
/// Shuts down the sending part of the socket connection.
virtual void shutdown();
/// Shuts down both the receiving and the sending part
/// of the socket connection.
virtual int sendBytes(const void* buffer, int length, int flags = 0);
/// Sends the contents of the given buffer through
/// the socket.
@@ -166,7 +166,7 @@ public:
///
/// Certain socket implementations may also return a negative
/// value denoting a certain condition.
virtual int receiveBytes(void* buffer, int length, int flags = 0);
/// Receives data from the socket and stores it
/// in buffer. Up to length bytes are received.
@@ -175,21 +175,21 @@ public:
///
/// Certain socket implementations may also return a negative
/// value denoting a certain condition.
virtual int sendTo(const void* buffer, int length, const SocketAddress& address, int flags = 0);
/// Sends the contents of the given buffer through
/// the socket to the given address.
///
/// Returns the number of bytes sent, which may be
/// less than the number of bytes specified.
virtual int receiveFrom(void* buffer, int length, SocketAddress& address, int flags = 0);
/// Receives data from the socket and stores it
/// in buffer. Up to length bytes are received.
/// Stores the address of the sender in address.
///
/// Returns the number of bytes received.
virtual void sendUrgent(unsigned char data);
/// Sends one byte of urgent data through
/// the socket.
@@ -198,24 +198,24 @@ public:
///
/// The preferred way for a socket to receive urgent data
/// is by enabling the SO_OOBINLINE option.
virtual int available();
/// Returns the number of bytes available that can be read
/// without causing the socket to block.
virtual bool poll(const Poco::Timespan& timeout, int mode);
/// Determines the status of the socket, using a
/// Determines the status of the socket, using a
/// call to select().
///
///
/// The mode argument is constructed by combining the values
/// of the SelectMode enumeration.
///
/// Returns true if the next operation corresponding to
/// mode will not block, false otherwise.
virtual void setSendBufferSize(int size);
/// Sets the size of the send buffer.
virtual int getSendBufferSize();
/// Returns the size of the send buffer.
///
@@ -225,7 +225,7 @@ public:
virtual void setReceiveBufferSize(int size);
/// Sets the size of the receive buffer.
virtual int getReceiveBufferSize();
/// Returns the size of the receive buffer.
///
@@ -235,7 +235,7 @@ public:
virtual void setSendTimeout(const Poco::Timespan& timeout);
/// Sets the send timeout for the socket.
virtual Poco::Timespan getSendTimeout();
/// Returns the send timeout for the socket.
///
@@ -248,20 +248,20 @@ public:
///
/// On systems that do not support SO_RCVTIMEO, a
/// workaround using poll() is provided.
virtual Poco::Timespan getReceiveTimeout();
/// Returns the receive timeout for the socket.
///
/// The returned timeout may be different than the
/// timeout previously set with setReceiveTimeout(),
/// as the system is free to adjust the value.
virtual SocketAddress address();
/// Returns the IP address and port number of the socket.
virtual SocketAddress peerAddress();
/// Returns the IP address and port number of the peer socket.
void setOption(int level, int option, int value);
/// Sets the socket option specified by level and option
/// to the given integer value.
@@ -273,64 +273,64 @@ public:
void setOption(int level, int option, unsigned char value);
/// Sets the socket option specified by level and option
/// to the given integer value.
void setOption(int level, int option, const Poco::Timespan& value);
/// Sets the socket option specified by level and option
/// to the given time value.
void setOption(int level, int option, const IPAddress& value);
/// Sets the socket option specified by level and option
/// to the given time value.
virtual void setRawOption(int level, int option, const void* value, poco_socklen_t length);
/// Sets the socket option specified by level and option
/// to the given time value.
void getOption(int level, int option, int& value);
/// Returns the value of the socket option
/// Returns the value of the socket option
/// specified by level and option.
void getOption(int level, int option, unsigned& value);
/// Returns the value of the socket option
/// Returns the value of the socket option
/// specified by level and option.
void getOption(int level, int option, unsigned char& value);
/// Returns the value of the socket option
/// Returns the value of the socket option
/// specified by level and option.
void getOption(int level, int option, Poco::Timespan& value);
/// Returns the value of the socket option
/// Returns the value of the socket option
/// specified by level and option.
void getOption(int level, int option, IPAddress& value);
/// Returns the value of the socket option
/// Returns the value of the socket option
/// specified by level and option.
virtual void getRawOption(int level, int option, void* value, poco_socklen_t& length);
/// Returns the value of the socket option
/// specified by level and option.
/// Returns the value of the socket option
/// specified by level and option.
void setLinger(bool on, int seconds);
/// Sets the value of the SO_LINGER socket option.
void getLinger(bool& on, int& seconds);
/// Returns the value of the SO_LINGER socket option.
void setNoDelay(bool flag);
/// Sets the value of the TCP_NODELAY socket option.
bool getNoDelay();
/// Returns the value of the TCP_NODELAY socket option.
void setKeepAlive(bool flag);
/// Sets the value of the SO_KEEPALIVE socket option.
bool getKeepAlive();
/// Returns the value of the SO_KEEPALIVE socket option.
void setReuseAddress(bool flag);
/// Sets the value of the SO_REUSEADDR socket option.
bool getReuseAddress();
/// Returns the value of the SO_REUSEADDR socket option.
@@ -338,22 +338,22 @@ public:
/// Sets the value of the SO_REUSEPORT socket option.
/// Does nothing if the socket implementation does not
/// support SO_REUSEPORT.
bool getReusePort();
/// Returns the value of the SO_REUSEPORT socket option.
///
/// Returns false if the socket implementation does not
/// support SO_REUSEPORT.
void setOOBInline(bool flag);
/// Sets the value of the SO_OOBINLINE socket option.
bool getOOBInline();
/// Returns the value of the SO_OOBINLINE socket option.
void setBroadcast(bool flag);
/// Sets the value of the SO_BROADCAST socket option.
bool getBroadcast();
/// Returns the value of the SO_BROADCAST socket option.
@@ -397,7 +397,7 @@ public:
protected:
SocketImpl();
/// Creates a SocketImpl.
SocketImpl(poco_socket_t sockfd);
/// Creates a SocketImpl using the given native socket.
@@ -443,22 +443,23 @@ protected:
static void error(int code);
/// Throws an appropriate exception for the given error code.
static void error(int code, const std::string& arg);
/// Throws an appropriate exception for the given error code.
private:
SocketImpl(const SocketImpl&);
SocketImpl& operator = (const SocketImpl&);
poco_socket_t _sockfd;
Poco::Timespan _recvTimeout;
Poco::Timespan _sndTimeout;
bool _blocking;
bool _isBrokenTimeout;
friend class Socket;
friend class SecureSocketImpl;
friend class PollSetImpl;
};