Open Lighting Architecture: include/ola/network/SocketCloser.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
SocketCloser.h
Go to the documentation of this file.
1/*
2 * This library is free software; you can redistribute it and/or
3 * modify it under the terms of the GNU Lesser General Public
4 * License as published by the Free Software Foundation; either
5 * version 2.1 of the License, or (at your option) any later version.
6 *
7 * This library is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public
13 * License along with this library; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 * SocketCloser.h
17 * Close a socket when the object goes out of scope.
18 * Copyright (C) 2013 Simon Newton
19 */
20
28
29#ifndef INCLUDE_OLA_NETWORK_SOCKETCLOSER_H_
30#define INCLUDE_OLA_NETWORK_SOCKETCLOSER_H_
31
32#include <unistd.h>
33#include <ola/base/Macro.h>
34
35namespace ola {
36namespace network {
37
42
49 class SocketCloser {
50 public:
55 explicit SocketCloser(int fd)
56 : m_fd(fd) {
57 }
58
62 ~SocketCloser();
63
72 int Release() {
73 int fd = m_fd;
74 m_fd = -1;
75 return fd;
76 }
77
78 private:
79 int m_fd;
80
81 SocketCloser(const SocketCloser &) = delete;
82 const SocketCloser &operator=(const SocketCloser &) = delete;
83};
84
87} // namespace network
88} // namespace ola
89#endif // INCLUDE_OLA_NETWORK_SOCKETCLOSER_H_
Macro.h
Helper macros.
ola::network::SocketCloser
Automatically close a socket when it goes out of scope.
Definition SocketCloser.h:49
ola::network::SocketCloser::~SocketCloser
~SocketCloser()
Destructor.
Definition SocketCloser.cpp:33
ola::network::SocketCloser::SocketCloser
SocketCloser(int fd)
Create a new SocketCloser.
Definition SocketCloser.h:55
ola::network::SocketCloser::Release
int Release()
Release the file descriptor.
Definition SocketCloser.h:72
ola::network
Code for network communication.
Definition AdvancedTCPConnector.cpp:28
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44