added a socket class to wrap the C socket API.
authorLoïc Collignon <loic.collignon@iot.bzh>
Wed, 8 Mar 2017 13:40:24 +0000 (14:40 +0100)
committerRomain Forlot <romain.forlot@iot.bzh>
Thu, 16 Mar 2017 16:10:39 +0000 (17:10 +0100)
Change-Id: Id90c60caba93b65011def0cc01232a7a2d7dbac4
Signed-off-by: Loïc Collignon <loic.collignon@iot.bzh>
src/utils/socket.cpp [new file with mode: 0644]
src/utils/socket.hpp [new file with mode: 0644]

diff --git a/src/utils/socket.cpp b/src/utils/socket.cpp
new file mode 100644 (file)
index 0000000..8badddf
--- /dev/null
@@ -0,0 +1,89 @@
+/*
+ * Copyright (C) 2015, 2016 ,2017 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ * Author "Loïc Collignon" <loic.collignon@iot.bzh>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <unistd.h>
+#include "socket.hpp"
+
+namespace utils
+{
+       /// @brief Construct a default, invalid, socket.
+       socket_t::socket_t()
+               : socket_{INVALID_SOCKET}
+       {
+       }
+
+       /// @brief Construct a socket by moving an existing one.
+       socket_t::socket_t(socket_t&& s)
+               : socket_{s.socket_}
+       {
+               s.socket_ = INVALID_SOCKET;
+       }
+
+       /// @brief Destruct the socket.
+       socket_t::~socket_t()
+       {
+               if(socket_ != INVALID_SOCKET)
+                       ::close(socket_);
+       }
+       
+       /// @brief Test if socket is valid.
+       /// @return true if valid, false otherwise.
+       socket_t::operator bool() const
+       {
+               return socket_ != INVALID_SOCKET;
+       }
+       
+       /// @brief Open the socket.
+       /// @param[in] domain Specifies the communications domain in which a socket is to be created.
+       /// @param[in] type Specifies the type of socket to be created.
+       /// @param[in] protocol Specifies a particular protocol to be used with the socket. Specifying a protocol of 0 causes socket() to use an unspecified default protocol appropriate for the requested socket type.
+       /// @return Upon successful completion, shall return a non-negative integer, the socket file descriptor. Otherwise, a value of -1 shall be returned and errno set to indicate the error.
+       int socket_t::open(int domain, int type, int protocol)
+       {
+               close();
+               socket_ = ::socket(domain, type, protocol);
+               return socket_;
+       }
+       
+       /// @brief Close the socket.
+       /// @return 0 if success.
+       int socket_t::close()
+       {
+               return socket_ != INVALID_SOCKET ? ::close(socket_) : 0;
+       }
+       
+       /// @brief Set socket option.
+       /// @return 0 if success.
+       int socket_t::setopt(int level, int optname, const void* optval, socklen_t optlen)
+       {
+               return socket_ != INVALID_SOCKET ? ::setsockopt(socket_, level, optname, optval, optlen) : 0;
+       }
+       
+       /// @brief Bind the socket.
+       /// @return 0 if success.
+       int socket_t::bind(const struct sockaddr* addr, socklen_t len)
+       {
+               return socket_ != INVALID_SOCKET ? ::bind(socket_, addr, len) : 0;
+       }
+               
+       /// @brief Get the file descriptor.
+       /// @return The socket's file descriptor
+       int socket_t::socket() const
+       {
+               return socket_;
+       }
+}
diff --git a/src/utils/socket.hpp b/src/utils/socket.hpp
new file mode 100644 (file)
index 0000000..e9ddf07
--- /dev/null
@@ -0,0 +1,46 @@
+#pragma once
+
+/*
+ * Copyright (C) 2015, 2016 ,2017 "IoT.bzh"
+ * Author "Romain Forlot" <romain.forlot@iot.bzh>
+ * Author "Loïc Collignon" <loic.collignon@iot.bzh>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <sys/socket.h>
+
+#define INVALID_SOCKET -1
+
+namespace utils
+{
+       class socket_t
+       {
+       public:
+               socket_t();
+               socket_t(const socket_t&) = delete;
+               socket_t(socket_t&&);
+               ~socket_t();
+               
+               explicit operator bool() const;
+               
+               int open(int domain, int type, int protocol);
+               int close();
+               int setopt(int level, int optname, const void* optval, socklen_t optlen);
+               int socket() const;
+               int bind(const struct sockaddr* addr, socklen_t len);
+               
+       private:
+               int socket_;
+       };
+}
+