mpd/src/event/ServerSocket.hxx
Max Kellermann 0ff4350352 event/ServerSocket: pass UniqueSocketDescriptor by value
Passing it by value is actually smaller (32 bit) than the rvalue
reference (64 bit pointer), and it ensures that the object is consumed
after the call returns, no matter how the methods are implemented.
2017-11-10 20:43:14 +01:00

125 lines
2.9 KiB
C++

/*
* Copyright 2003-2017 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_SERVER_SOCKET_HXX
#define MPD_SERVER_SOCKET_HXX
#include <list>
class SocketAddress;
class AllocatedSocketAddress;
class UniqueSocketDescriptor;
class EventLoop;
class AllocatedPath;
class OneServerSocket;
/**
* A socket that accepts incoming stream connections (e.g. TCP).
*/
class ServerSocket {
friend class OneServerSocket;
EventLoop &loop;
std::list<OneServerSocket> sockets;
unsigned next_serial;
public:
ServerSocket(EventLoop &_loop);
~ServerSocket();
EventLoop &GetEventLoop() {
return loop;
}
private:
OneServerSocket &AddAddress(SocketAddress address);
OneServerSocket &AddAddress(AllocatedSocketAddress &&address);
/**
* Add a listener on a port on all IPv4 interfaces.
*
* @param port the TCP port
*/
void AddPortIPv4(unsigned port);
/**
* Add a listener on a port on all IPv6 interfaces.
*
* @param port the TCP port
*/
void AddPortIPv6(unsigned port);
public:
/**
* Add a listener on a port on all interfaces.
*
* Throws #std::runtime_error on error.
*
* @param port the TCP port
* @param error location to store the error occurring
*/
void AddPort(unsigned port);
/**
* Resolves a host name, and adds listeners on all addresses in the
* result set.
*
* Throws #std::runtime_error on error.
*
* @param hostname the host name to be resolved
* @param port the TCP port
* @param error location to store the error occurring
*/
void AddHost(const char *hostname, unsigned port);
/**
* Add a listener on a Unix domain socket.
*
* Throws #std::runtime_error on error.
*
* @param path the absolute socket path
* @param error location to store the error occurring
*/
void AddPath(AllocatedPath &&path);
/**
* Add a socket descriptor that is accepting connections. After this
* has been called, don't call server_socket_open(), because the
* socket is already open.
*
* Throws #std::runtime_error on error.
*/
void AddFD(int fd);
/**
* Throws #std::runtime_error on error.
*/
void Open();
void Close();
protected:
virtual void OnAccept(UniqueSocketDescriptor fd,
SocketAddress address, int uid) = 0;
};
#endif