Omni C++ Framework - omni/net/socket.hpp

omni/net/socket.hpp


001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:

020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:

040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:

060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:

080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:

100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
117:
118:
119:

120:
121:
122:
123:
124:
125:
126:
127:
128:
129:
130:
131:
132:
133:
134:
135:
136:
137:
138:
139:

140:
141:
142:
143:
144:
145:
146:
147:
148:
149:
150:
151:
152:
153:
154:
155:
156:
157:
158:
159:

160:
161:
162:
163:
164:
165:
166:
167:
168:
169:
170:
171:



























































































































































































/*
 * Copyright (c), Zeriph Enterprises

 * All rights reserved.

 * 

 * Contributor(s):

 * Zechariah Perez, omni (at) zeriph (dot) com

 * 

 * THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY

 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#if !defined(OMNI_SOCKET_HPP)

#define OMNI_SOCKET_HPP 1

#include <omni/types/net_t.hpp>

#include <omni/net/endpoint_descriptor.hpp>

#if defined(OMNI_SAFE_SOCKET)

    #include <omni/sync/basic_lock.hpp>

#endif



namespace omni {

    namespace net {

        class socket

        {

            public:

                socket(omni::net::socket_type type, omni::net::protocol_type protocol);

                socket(omni::net::address_family family,

                       omni::net::socket_type type,

                       omni::net::protocol_type protocol);

                ~socket();

                

                omni::net::address_family address_family() const;

                omni::net::socket_error accept(omni::net::endpoint_descriptor& remote_ep);

                omni::net::socket_error bind();

                omni::net::socket_error bind(uint16_t port);

                omni::net::socket_error bind(uint32_t ip, uint16_t port);

                omni::net::socket_error bind(const std::string& ip, uint16_t port);

                omni::net::socket_error bind(const std::wstring& ip, uint16_t port);

                omni::net::socket_error bind(const std::string& ip);

                omni::net::socket_error bind(const std::wstring& ip);

                uint32_t bound_endpoint() const;

                uint16_t bound_port() const;

                omni::net::socket_error close();

                omni::net::socket_error close(uint16_t timeout);

                omni::net::socket_error connect();

                omni::net::socket_error connect(uint32_t ip, uint16_t port);

                omni::net::socket_error connect(const std::string& ip, uint16_t port);

                omni::net::socket_error connect(const std::wstring& ip, uint16_t port);

                omni::net::socket_error connect_host(const std::string& host, uint16_t port);

                omni::net::socket_error connect_host(const std::wstring& host, uint16_t port);

                omni::net::socket_error disconnect(bool reuse);

                uint32_t endpoint() const;

                omni::net::socket_error get_socket_option(omni::net::socket_option_level op_level, int32_t op_name, int32_t& op_val);

                omni::net::socket_error get_socket_option(omni::net::socket_option_level op_level, omni::net::socket_option op_name, int32_t& op_val);

                omni::net::socket_error get_socket_option(omni::net::socket_option_level op_level, omni::net::tcp_option op_name, int32_t& op_val);

                omni::net::socket_t native_handle() const;

                omni::net::socket_error open();

                omni::net::socket_error open(omni::net::socket_type type, omni::net::protocol_type protocol);

                omni::net::socket_error open(omni::net::address_family family, omni::net::socket_type type, omni::net::protocol_type protocol);

                omni::net::socket_error ioc(uint32_t op_code, omni::net::xfr_t* val, int32_t& result);

                bool is_bound() const;

                bool is_connected() const;

                bool is_open() const;

                bool is_shutdown() const;

                bool is_listening() const;

                omni::net::socket_error listen();

                omni::net::socket_error listen(int32_t backlog);

                omni::net::socket_error last_error() const;

                uint16_t port() const;

                omni::net::protocol_type protocol() const;

                omni::net::socket_error receive(char* buffer, uint32_t len, uint32_t& rcvd);

                omni::net::socket_error receive(int8_t* buffer, uint32_t len, uint32_t& rcvd);

                omni::net::socket_error receive(uint8_t* buffer, uint32_t len, uint32_t& rcvd);

                omni::net::socket_error receive(char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd);

                omni::net::socket_error receive(int8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd);

                omni::net::socket_error receive(uint8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd);

                omni::net::socket_error receive_from(char* buffer, uint32_t len, uint32_t& rcvd);

                omni::net::socket_error receive_from(char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd);

                omni::net::socket_error receive_from(char* buffer, uint32_t len, std::string& from_ip, uint16_t& from_port, uint32_t& rcvd);

                omni::net::socket_error receive_from(char* buffer, uint32_t len, omni::net::socket_flags flags, std::string& from_ip, uint16_t& from_port, uint32_t& rcvd);

                omni::net::socket_error send(const char* buffer, uint32_t len, uint32_t& sent);

                omni::net::socket_error send(const int8_t* buffer, uint32_t len, uint32_t& sent);

                omni::net::socket_error send(const uint8_t* buffer, uint32_t len, uint32_t& sent);

                omni::net::socket_error send(const char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent);

                omni::net::socket_error send(const int8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent);

                omni::net::socket_error send(const uint8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent);

                omni::net::socket_error send_to(const char* buffer, uint32_t len, const std::string& ip, uint16_t port, uint32_t& sent);

                omni::net::socket_error send_to(const char* buffer, uint32_t len, omni::net::socket_flags flags, const std::string& ip, uint16_t port, uint32_t& sent);

                omni::net::socket_error set_socket_option(omni::net::socket_option_level op_level, int32_t op_name, int32_t op_val);

                omni::net::socket_error set_socket_option(omni::net::socket_option_level op_level, omni::net::socket_option op_name, int32_t op_val);

                omni::net::socket_error set_socket_option(omni::net::socket_option_level op_level, omni::net::tcp_option op_name, int32_t op_val);

                omni::net::socket& set_address_family(omni::net::address_family family);

                omni::net::socket& set_protocol_type(omni::net::protocol_type protocol);

                omni::net::socket& set_socket_type(omni::net::socket_type type);

                omni::net::socket_error shutdown(omni::net::socket_shutdown how);

                omni::net::socket_type socket_type() const;

                void swap(omni::net::socket& other);

                omni::string_t to_string_t() const;

                std::string to_string() const;

                std::wstring to_wstring() const;



                operator std::string() const

                {

                    return this->to_string();

                }



                operator std::wstring() const

                {

                    return this->to_wstring();

                }



                OMNI_MEMBERS_FW(omni::net::socket) // disposing,name,type(),hash()



                OMNI_OSTREAM_FW(omni::net::socket)



            private:

                socket(); // = delete

                socket(const omni::net::socket &cp); // = delete

                omni::net::socket& operator= (const omni::net::socket &other); // = delete

                

                omni::net::socket_t m_socket;

                omni::net::sockaddr_in_t m_addr;

                omni::net::address_family m_family;

                omni::net::protocol_type m_proto;

                omni::net::socket_type m_type;

                omni::net::socket_error m_last_err;

                uint32_t m_ep4;

                uint16_t m_port;

                uint32_t m_bep4;

                uint16_t m_bport;

                bool m_connected;

                bool m_bound;

                bool m_open;

                bool m_shut;

                bool m_listen;

                #if defined(OMNI_OS_WIN)

                    omni::net::wsa_info m_wsa;

                #endif

                #if defined(OMNI_SAFE_SOCKET)

                    mutable omni::sync::basic_lock m_mtx;

                #endif



                omni::net::socket_error _close(uint16_t timeout, bool shutdown);

        };



        // TODO: future -> for systems that support dual-stack sockets via ip6

        //class socket6 {  enum_t mode = DUAL || IP6; };



        // TODO: future -> for systems that do NOT support dual-stack sockets

        //class dual_socket { omni::net::socket ip4; omni::net::socket6 ip6;  }



        // TODO: future -> AF_UNIX address family is for IPC

        // so NOT for omni::net::socket .. it would be for omni::ipc::socket

    }

}



namespace std {

    inline void swap(omni::net::socket& o1, omni::net::socket& o2)

    {

        o1.swap(o2);

    }

}



#endif // OMNI_SOCKET_HPP