add socket module

1 files changed, 139 insertions, 0 deletions

diff --git a/xmake/core/base/socket.lua b/xmake/core/base/socket.lua
new file mode 100644
index 000000000..97a04bb8b
--- /dev/null
+++ b/xmake/core/base/socket.lua
@@ -0,0 +1,139 @@
+--!A cross-platform build utility based on Lua
+--
+-- 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.
+--
+-- Copyright (C) 2015 - 2019, TBOOX Open Source Group.
+--
+-- @author      ruki
+-- @file        socket.lua
+--
+
+-- define module
+local io          = io or {}
+local socket      = socket or {}
+local _instance   = _instance or {}
+
+-- load modules
+local table  = require("base/table")
+local string = require("base/string")
+
+-- new a socket
+function _instance.new(socktype, family, sock)
+    local socket   = table.inherit(_instance)
+    socket._SOCK   = sock
+    socket._TYPE   = socktype or "tcp"
+    socket._FAMILY = family or "ipv4"
+    setmetatable(socket, _instance)
+    return socket
+end
+
+-- get socket type
+function _instance:type()
+    return self._TYPE
+end
+
+-- get socket family
+function _instance:family()
+    return self._FAMILY
+end
+
+-- get socket rawfd
+function _instance:rawfd()
+
+    -- ensure opened
+    local ok, errors = self:_ensure_opened()
+    if not ok then
+        return nil, errors
+    end
+
+    -- get rawfd
+    local result, errors = io.socket_rawfd(self._SOCK)
+    if not result and errors then
+        errors = string.format("%s: %s", self, errors)
+    end
+    return result, errors
+end
+
+-- connect socket 
+function _instance:connect(addr, port)
+
+    -- ensure opened
+    local ok, errors = self:_ensure_opened()
+    if not ok then
+        return -1, errors
+    end
+
+    -- connect it
+    local result, errors = io.socket_connect(self._SOCK, addr, port, self:family())
+    if result < 0 and errors then
+        errors = string.format("%s: %s", self, errors)
+    end
+    return result, errors
+end
+
+-- close socket
+function _instance:close()
+
+    -- ensure opened
+    local ok, errors = self:_ensure_opened()
+    if not ok then
+        return false, errors
+    end
+
+    -- close it
+    ok = io.socket_close(self._SOCK)
+    if ok then
+        self._SOCK = nil
+    end
+    return ok
+end
+
+-- ensure the socket is opened
+function _instance:_ensure_opened()
+    if not self._SOCK then
+        return false, string.format("%s: has been closed!", self)
+    end
+    return true
+end
+
+-- tostring(socket)
+function _instance:__tostring()
+    local rawfd = self:rawfd() or "closed"
+    return string.format("<socket: %s%s/%s>", self:type(), self:family() == "ipv6" and "6" or "4", rawfd)
+end
+
+-- gc(socket)
+function _instance:__gc()
+    if self._SOCK and io.socket_close(self._SOCK) then
+        self._SOCK = nil
+    end
+end
+
+-- open a socket
+--
+-- @param socktype      the socket type, e.g. tcp, udp, icmp
+-- @param family        the address family, e.g. ipv4, ipv6
+--
+-- @return the socket instance
+--
+function socket.open(socktype, family)
+    local sock, errors = io.socket_open(socktype, family)
+    if sock then
+        return _instance.new(socktype, family, sock)
+    else
+        return nil, errors or string.format("failed to open socket(%s/%s)!", socktype, family)
+    end
+end
+
+-- return module
+return socket