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:
172:
173:
174:
175:
176:
177:
178:
179:
180:
181:
182:
183:
184:
185:
186:
187:
188:
189:
190:
191:
192:
193:
194:
195:
196:
197:
198:
199:
200:
201:
202:
203:
204:
205:
206:
207:
208:
209:
210:
211:
212:
213:
214:
215:
216:
217:
218:
219:
220:
221:
222:
223:
224:
225:
226:
227:
228:
229:
230:
231:
232:
233:
234:
235:
236:
237:
238:
239:
240:
241:
242:
243:
244:
245:
246:
247:
248:
249:
250:
251:
252:
253:
254:
255:
256:
257:
258:
259:
260:
261:
262:
263:
264:
265:
266:
267:
268:
269:
270:
271:
272:
273:
274:
275:
276:
277:
278:
279:
280:
281:
282:
283:
284:
285:
286:
287:
288:
289:
290:
291:
292:
293:
294:
295:
296:
297:
298:
299:
300:
301:
302:
303:
304:
305:
306:
307:
308:
309:
310:
311:
312:
313:
314:
315:
316:
317:
318:
319:
320:
321:
322:
323:
324:
325:
326:
327:
328:
329:
330:
331:
332:
333:
334:
335:
336:
337:
338:
339:
340:
341:
342:
343:
344:
345:
346:
347:
348:
349:
350:
351:
352:
353:
354:
355:
356:
357:
358:
359:
360:
361:
362:
363:
364:
365:
366:
367:
368:
369:
370:
371:
372:
373:
374:
375:
376:
377:
378:
379:
380:
381:
382:
383:
384:
385:
386:
387:
388:
389:
390:
391:
392:
393:
394:
395:
396:
397:
398:
399:
400:
401:
402:
403:
404:
405:
406:
407:
408:
409:
410:
411:
412:
413:
414:
415:
416:
417:
418:
419:
420:
421:
422:
423:
424:
425:
426:
427:
428:
429:
430:
431:
432:
433:
434:
435:
436:
437:
438:
439:
440:
441:
442:
443:
444:
445:
446:
447:
448:
449:
450:
451:
452:
453:
454:
455:
456:
457:
458:
459:
460:
461:
462:
463:
464:
465:
466:
467:
468:
469:
470:
471:
472:
473:
474:
475:
476:
477:
478:
479:
480:
481:
482:
483:
484:
485:
486:
487:
488:
489:
490:
491:
492:
493:
494:
495:
496:
497:
498:
499:
500:
501:
502:
503:
504:
505:
506:
507:
508:
509:
510:
511:
512:
513:
514:
515:
516:
517:
518:
519:
520:
521:
522:
523:
524:
525:
526:
527:
528:
529:
530:
531:
532:
533:
534:
535:
536:
537:
538:
539:
540:
541:
542:
543:
544:
545:
546:
547:
548:
549:
550:
551:
552:
553:
554:
555:
556:
557:
558:
559:
560:
561:
562:
563:
564:
565:
566:
567:
568:
569:
570:
571:
572:
573:
574:
575:
576:
577:
578:
579:
580:
581:
582:
583:
584:
585:
586:
587:
588:
589:
590:
591:
592:
593:
594:
595:
596:
597:
598:
599:
600:
601:
602:
603:
604:
605:
606:
607:
608:
609:
610:
611:
612:
613:
614:
615:
616:
617:
618:
619:
620:
621:
622:
623:
624:
625:
626:
627:
628:
629:
630:
631:
632:
633:
634:
635:
636:
637:
638:
639:
640:
641:
642:
643:
644:
645:
646:
647:
648:
649:
650:
651:
652:
653:
654:
655:
656:
657:
658:
659:
660:
661:
662:
663:
664:
665:
666:
667:
668:
669:
670:
671:
672:
673:
674:
675:
676:
677:
678:
679:
680:
681:
682:
683:
684:
685:
686:
687:
688:
689:
690:
691:
692:
693:
694:
695:
696:
697:
698:
699:
700:
701:
702:
703:
704:
705:
706:
707:
708:
709:
710:
711:
712:
713:
714:
715:
716:
717:
718:
719:
720:
721:
722:
723:
724:
725:
726:
727:
728:
729:
730:
731:
732:
733:
734:
735:
736:
737:
738:
739:
740:
741:
742:
743:
744:
745:
746:
747:
748:
749:
750:
751:
752:
753:
754:
755:
756:
757:
758:
759:
760:
761:
762:
763:
764:
765:
766:
767:
768:
769:
770:
771:
772:
773:
774:
775:
776:
777:
778:
779:
780:
781:
782:
783:
784:
785:
786:
787:
788:
789:
790:
791:
792:
793:
794:
795:
796:
797:
798:
799:
800:
801:
802:
803:
804:
805:
806:
807:
808:
809:
810:
811:
812:
813:
814:
815:
816:
817:
818:
819:
820:
821:
822:
823:
824:
825:
826:
827:
828:
829:
830:
831:
832:
833:
834:
835:
836:
837:
838:
839:
840:
841:
842:
843:
844:
845:
846:
847:
848:
849:
850:
851:
852:
853:
854:
855:
856:
857:
858:
859:
860:
861:
862:
863:
864:
865:
866:
867:
868:
869:
870:
871:
872:
873:
874:
875:
876:
877:
878:
879:
880:
881:
882:
883:
884:
885:
886:
887:
888:
889:
890:
891:
892:
893:
894:
895:
896:
897:
898:
899:
900:
901:
902:
903:
904:
905:
906:
907:
908:
909:
910:
911:
912:
913:
914:
915:
916:
917:
918:
919:
920:
921:
922:
923:
924:
925:
926:
927:
928:
929:
930:
931:
932:
933:
934:
935:
936:
937:
938:
939:
940:
941:
942:
943:
944:
945:
946:
947:
948:




















































































































































































































































































































































































































































































































































































































































































































































































































































































































































































/*
* 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.
*/
#include <omni/net/socket.hpp>
#include <omni/net/util.hpp>
#include <omni/defs/debug.hpp>

#if defined(OMNI_SAFE_SOCKET)
    #define OMNI_SAFE_SOCKMTX_FW ,m_mtx()
    #define OMNI_SAFE_SOCKLOCK_FW this->m_mtx.lock();
    #define OMNI_SAFE_SOCKUNLOCK_FW this->m_mtx.unlock();
    #define OMNI_SAFE_SOCKALOCK_FW omni::sync::scoped_basic_lock uuid12345(&this->m_mtx);
    #define OMNI_SAFE_SOCKOALOCK_FW(o) omni::sync::scoped_basic_lock uuid54321(&o.m_mtx);
#else
    #define OMNI_SAFE_SOCKMTX_FW
    #define OMNI_SAFE_SOCKLOCK_FW
    #define OMNI_SAFE_SOCKUNLOCK_FW
    #define OMNI_SAFE_SOCKALOCK_FW
    #define OMNI_SAFE_SOCKOALOCK_FW(o)
#endif

#if defined(OMNI_OS_WIN)
    #define OMNI_SOCK_WSA_FW , m_wsa(true)
    #define OMNI_SOCK_CLOSE_FW this->m_wsa.close();
    #define OMNI_SOCK_OPEN_FW if (!this->m_wsa.open()) { return (this->m_last_err = omni::net::parse_error(this->m_wsa.error())); }
#else
    #define OMNI_SOCK_WSA_FW
    #define OMNI_SOCK_CLOSE_FW
    #define OMNI_SOCK_OPEN_FW
#endif

omni::net::socket_error omni::net::socket::_close(uint16_t timeout, bool shutdown)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    if (this->m_connected || this->m_bound) {
        if (timeout > 0) {
            struct linger lop;
            lop.l_onoff = 1;
            lop.l_linger = timeout;
            if (::setsockopt(this->m_socket, SOL_SOCKET, SO_LINGER, reinterpret_cast<char*>(&lop), sizeof(struct linger)) != 0) {
                return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
            }
        }
        if (shutdown && (this->shutdown(omni::net::socket_shutdown::BOTH) != omni::net::socket_error::SUCCESS)) {
            OMNI_DBGE("could not shutdown the socket")
            return this->m_last_err;
        }
        if (OMNI_SOCKET_CLOSE_FW(this->m_socket) != 0) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        OMNI_SOCK_CLOSE_FW
        if (shutdown) {
            this->m_socket = OMNI_INVALID_SOCKET;
            std::memset(&this->m_addr, 0, sizeof(this->m_addr));
        }
        this->m_open = false;
        this->m_connected = false;
        this->m_bound = false;
        this->m_listen = false;
        this->m_last_err = omni::net::socket_error::SUCCESS;
    } else {
        this->m_last_err = omni::net::socket_error::NOT_CONNECTED;
    }
    return this->m_last_err;
}

omni::net::socket::socket(omni::net::address_family family,
                         omni::net::socket_type type,
                         omni::net::protocol_type protocol) :
    OMNI_CTOR_FW(omni::net::socket)
    m_socket(OMNI_INVALID_SOCKET), m_addr(), m_family(family), m_proto(protocol), m_type(type),
    m_last_err(omni::net::socket_error::UNSPECIFIED), m_ep4(), m_port(), m_bep4(), m_bport(),
    m_connected(), m_bound(), m_open(), m_shut(), m_listen()
    OMNI_SOCK_WSA_FW
    OMNI_SAFE_SOCKMTX_FW
{
    if (this->open() != omni::net::socket_error::SUCCESS) {
        OMNI_D1_FW("error opening the socket");
    }
}

omni::net::socket::socket(omni::net::socket_type type,
                         omni::net::protocol_type protocol) :
    OMNI_CTOR_FW(omni::net::socket)
    m_socket(OMNI_INVALID_SOCKET), m_addr(), m_family(omni::net::address_family::UNSPECIFIED),
    m_proto(protocol), m_type(type), m_last_err(omni::net::socket_error::UNSPECIFIED), m_ep4(),
    m_port(), m_bep4(), m_bport(), m_connected(), m_bound(), m_open(), m_shut(), m_listen()
    OMNI_SOCK_WSA_FW
    OMNI_SAFE_SOCKMTX_FW
{
    if (this->open() != omni::net::socket_error::SUCCESS) {
        OMNI_D1_FW("error opening the socket");
    }
}

omni::net::socket::~socket()
{
    OMNI_TRY_FW
    if (this->close() != omni::net::socket_error::SUCCESS) {
        OMNI_D1_FW("error closing socket");
    }
    OMNI_DTOR_FW
    OMNI_CATCH_FW
    OMNI_D5_FW("destroyed");
}

omni::net::socket_error omni::net::socket::accept(omni::net::endpoint_descriptor& remote_ep)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    } else if (!this->m_listen) { // includes this->m_bound (can't listen if not bound)
        return (this->m_last_err = omni::net::socket_error::DESTINATION_ADDRESS_REQUIRED);
    } else if (remote_ep.is_connected()) {
        return (this->m_last_err = omni::net::socket_error::IS_CONNECTED);
    }
    return (this->m_last_err = remote_ep.connect(this->m_socket));
}

omni::net::socket_error omni::net::socket::bind()
{
    OMNI_SAFE_SOCKLOCK_FW
    uint32_t ip = this->m_ep4;
    uint16_t port = this->m_port;
    OMNI_SAFE_SOCKUNLOCK_FW
    return this->bind(ip, port);
}

omni::net::socket_error omni::net::socket::bind(uint16_t port)
{
    OMNI_SAFE_SOCKLOCK_FW
    uint32_t ip = this->m_ep4;
    OMNI_SAFE_SOCKUNLOCK_FW
    return this->bind(ip, port);
}

omni::net::socket_error omni::net::socket::bind(uint32_t ip, uint16_t port)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    } else if (this->m_connected) { // can't bind to a 'connect()'ed socket
        return (this->m_last_err = omni::net::socket_error::IS_CONNECTED);
    } else if (this->m_bound) {
        return (this->m_last_err = omni::net::socket_error::ADDRESS_ALREADY_IN_USE);
    }
    this->m_bep4 = ip;
    this->m_bport = port;
    std::memset(&this->m_addr, 0, sizeof(this->m_addr));
    switch (this->m_family.value()) {
        case omni::net::address_family::INTERNETWORK: {
            this->m_addr.sin_family = static_cast<int>(this->m_family);
            this->m_addr.sin_port = htons(this->m_bport);
            this->m_addr.sin_addr.s_addr = htonl(this->m_bep4);
        } break;
        default:
            // omni::net::address_family::UNIX is not support in this socket since that's an IPC protocol
            // omni::net::address_family::INTERNETWORK_V6 is not supported in this socket, that's socket6
            return (this->m_last_err = omni::net::socket_error::PROTOCOL_FAMILY_NOT_SUPPORTED);
    }
    if (::bind(this->m_socket, omni::net::to_sockaddr(this->m_addr), sizeof(this->m_addr)) != 0) {
        this->m_bound = false;
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    this->m_bound = true;
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::bind(const std::string& ip, uint16_t port)
{
    uint32_t ep;
    if (omni::net::util::try_parse_ip4(ip, ep)) {
        return this->bind(ep, port);
    }
    return (this->m_last_err = omni::net::socket_error::INVALID_ARGUMENT);
}

omni::net::socket_error omni::net::socket::bind(const std::wstring& ip, uint16_t port)
{
    uint32_t ep;
    if (omni::net::util::try_parse_ip4(ip, ep)) {
        return this->bind(ep, port);
    }
    return (this->m_last_err = omni::net::socket_error::INVALID_ARGUMENT);
}

omni::net::socket_error omni::net::socket::bind(const std::string& ip)
{
    return this->bind(ip, 0);
}

omni::net::socket_error omni::net::socket::bind(const std::wstring& ip)
{
    return this->bind(ip, 0);
}

omni::net::socket_error omni::net::socket::close()
{
    return this->close(0);
}

omni::net::socket_error omni::net::socket::close(uint16_t timeout)
{
    return this->_close(timeout, false);
}

omni::net::socket_error omni::net::socket::connect()
{
    OMNI_SAFE_SOCKALOCK_FW
    // DEV_NOTE: htons/etc. could be macro's so we don't use global namespace (i.e. ::htons)
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    } else if (this->m_connected) {
        return (this->m_last_err = omni::net::socket_error::IS_CONNECTED);
    } else if (this->m_bound) {
        return (this->m_last_err = omni::net::socket_error::ADDRESS_ALREADY_IN_USE);
    }
    std::memset(&this->m_addr, 0, sizeof(this->m_addr));
    switch (this->m_family.value()) {
        case omni::net::address_family::INTERNETWORK: {
            this->m_addr.sin_family = static_cast<int>(this->m_family);
            this->m_addr.sin_port = htons(this->m_port);
            this->m_addr.sin_addr.s_addr = htonl(this->m_ep4);
        } break;
        default:
            // omni::net::address_family::UNIX is not support in this socket since that's an IPC protocol
            // omni::net::address_family::INTERNETWORK_V6 is not supported in this socket, that's a socket6
            return (this->m_last_err = omni::net::socket_error::PROTOCOL_FAMILY_NOT_SUPPORTED);
    }
    if (OMNI_SOCKET_CONNECT_FW(this->m_socket, omni::net::to_sockaddr(this->m_addr), sizeof(this->m_addr)) != 0) {
        this->m_connected = false;
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    this->m_connected = true;
    this->m_shut = false;
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
    
}

omni::net::socket_error omni::net::socket::connect(uint32_t ip, uint16_t port)
{
    OMNI_SAFE_SOCKLOCK_FW
    this->m_ep4 = ip;
    this->m_port = port;
    OMNI_SAFE_SOCKUNLOCK_FW
    return this->connect();
}

omni::net::socket_error omni::net::socket::connect(const std::string& ip, uint16_t port)
{
    uint32_t ep = 0;
    if (!omni::net::util::try_parse_ip4(ip, ep)) {
        return (this->m_last_err = omni::net::socket_error::ADDRESS_NOT_AVAILABLE);
    }
    return this->connect(ep, port);
}

omni::net::socket_error omni::net::socket::connect(const std::wstring& ip, uint16_t port)
{
    return this->connect(omni::string::util::to_string(ip), port);
}

omni::net::socket_error omni::net::socket::connect_host(const std::string& host, uint16_t port)
{
    omni::seq::std_string_t ip;
    omni::net::socket_error err = omni::net::util::get_ip(host, port, ip);
    if (err == omni::net::socket_error::SUCCESS) {
        if (ip.size() > 0) {
            return this->connect(ip[0], port);
        } else {
            return (this->m_last_err = omni::net::socket_error::ADDRESS_NOT_AVAILABLE);
        }
    }
    return (this->m_last_err = err);
}

omni::net::socket_error omni::net::socket::connect_host(const std::wstring& host, uint16_t port)
{
    return this->connect_host(omni::string::to_string(host), port);
}

omni::net::socket_error omni::net::socket::disconnect(bool reuse)
{
    return this->_close(0, reuse);
}

omni::net::socket_error omni::net::socket::ioc(uint32_t op_code, omni::net::xfr_t* val, int32_t& result)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_OS_WIN)
        result = ::ioctlsocket(this->m_socket, static_cast<long>(op_code), reinterpret_cast<u_long*>(val));
    #else
        result = ::ioctl(this->m_socket, static_cast<unsigned long>(op_code), val);
    #endif
    if (result == OMNI_SOCK_SYSERR_FW) {
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::get_socket_option(omni::net::socket_option_level op_level, int32_t op_name, int32_t& op_val)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    int err = 0;
    OMNI_SOCKLEN_FW sz;
    if ((op_level.value() == omni::net::socket_option_level::SOCKET) &&
        ((op_name == omni::net::socket_option::LINGER) || (op_name == omni::net::socket_option::DONT_LINGER)))
    {
        struct linger lop;
        std::memset(&lop, 0, sizeof(struct linger));
        sz = static_cast<OMNI_SOCKLEN_FW>(sizeof(struct linger));
        err = ::getsockopt(this->m_socket,
                         static_cast<int>(op_level),
                         static_cast<int>(omni::net::socket_option::LINGER),
                         reinterpret_cast<OMNI_SOCKET_XFR_T_FW*>(&lop),
                         &sz);
        if (err == 0) { op_val = static_cast<int32_t>(lop.l_linger); }
    } else {
        OMNI_SOCKET_XFR_T_FW* val = reinterpret_cast<OMNI_SOCKET_XFR_T_FW*>(&op_val);
        sz = static_cast<OMNI_SOCKLEN_FW>(sizeof(val));
        err = ::getsockopt(this->m_socket, static_cast<int>(op_level), static_cast<int>(op_name), val, &sz);
        if (err == 0) { op_val = *(reinterpret_cast<int32_t*>(val)); }
    }
    if (err != 0) { return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW)); }
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::get_socket_option(omni::net::socket_option_level op_level, omni::net::socket_option op_name, int32_t& op_val)
{
    return this->get_socket_option(op_level, static_cast<int32_t>(op_name.value()), op_val);
}

omni::net::socket_error omni::net::socket::get_socket_option(omni::net::socket_option_level op_level, omni::net::tcp_option op_name, int32_t& op_val)
{
    return this->get_socket_option(op_level, static_cast<int32_t>(op_name.value()), op_val);
}

omni::net::socket_error omni::net::socket::open()
{
    OMNI_SAFE_SOCKALOCK_FW
    if (this->m_open) {
        return (this->m_last_err = omni::net::socket_error::ADDRESS_ALREADY_IN_USE);
    }
    OMNI_SOCK_OPEN_FW
    this->m_socket = OMNI_SOCKET_OPEN_FW(this->m_family, this->m_type, this->m_proto);
    if (this->m_socket == OMNI_INVALID_SOCKET) {
        int err = OMNI_SOCKET_ERR_FW;
        OMNI_DBGEV("a system error occurred creating the socket: ", err)
        return (this->m_last_err = omni::net::parse_error(err));
    }
    this->m_open = true;
    this->m_shut = false;
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::open(omni::net::socket_type type, omni::net::protocol_type protocol)
{
    OMNI_SAFE_SOCKLOCK_FW
    this->m_type = type;
    this->m_proto = protocol;
    OMNI_SAFE_SOCKUNLOCK_FW
    return this->open();
}

omni::net::socket_error omni::net::socket::open(omni::net::address_family family, omni::net::socket_type type, omni::net::protocol_type protocol)
{
    OMNI_SAFE_SOCKLOCK_FW
    this->m_family = family;
    this->m_type = type;
    this->m_proto = protocol;
    OMNI_SAFE_SOCKUNLOCK_FW
    return this->open();
}

omni::net::socket_error omni::net::socket::listen()
{
    return this->listen(OMNI_SOCKET_DEFAULT_BACKLOG);
}

omni::net::socket_error omni::net::socket::listen(int32_t backlog)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    } else if (!this->m_bound) {
        return (this->m_last_err = omni::net::socket_error::DESTINATION_ADDRESS_REQUIRED);
    } else if (this->m_connected) {
        return (this->m_last_err = omni::net::socket_error::IS_CONNECTED);
    }
    if (backlog > OMNI_SOMAXCONN) {
        return (this->m_last_err = omni::net::socket_error::INVALID_ARGUMENT);
    }
    if (::listen(this->m_socket, static_cast<int>(backlog)) != 0) {
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    this->m_listen = true;
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::shutdown(omni::net::socket_shutdown how)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    } else if (this->m_shut) {
        return (this->m_last_err = omni::net::socket_error::SUCCESS);
    }
    int err = ::shutdown(this->m_socket, static_cast<int>(how));
    if (err == OMNI_SOCK_SYSERR_FW) {
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    this->m_shut = true;
    this->m_listen = false;
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::set_socket_option(omni::net::socket_option_level op_level, int32_t op_name, int32_t op_val)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    int err = 0;
    if ((op_level.value() == omni::net::socket_option_level::SOCKET) &&
        ((op_name == omni::net::socket_option::LINGER) || (op_name == omni::net::socket_option::DONT_LINGER)))
    {
        struct linger lop;
        std::memset(&lop, 0, sizeof(struct linger));
        if (op_name == omni::net::socket_option::LINGER) {
            lop.l_onoff = 1;
            lop.l_linger = op_val;
        }
        err = ::setsockopt(this->m_socket,
                         static_cast<int>(op_level),
                         static_cast<int>(omni::net::socket_option::LINGER),
                         reinterpret_cast<OMNI_SOCKET_XFR_T_FW*>(&lop),
                         sizeof(struct linger));
    } else {
        err = ::setsockopt(this->m_socket,
                         static_cast<int>(op_level),
                         static_cast<int>(op_name),
                         reinterpret_cast<OMNI_SOCKET_XFR_T_FW*>(&op_val),
                         sizeof(int32_t));
    }
    if (err != 0) {
        return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
    }
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::set_socket_option(omni::net::socket_option_level op_level, omni::net::socket_option op_name, int32_t op_val)
{
    return this->set_socket_option(op_level, static_cast<int32_t>(op_name.value()), op_val);
}

omni::net::socket_error omni::net::socket::set_socket_option(omni::net::socket_option_level op_level, omni::net::tcp_option op_name, int32_t op_val)
{
    return this->set_socket_option(op_level, static_cast<int32_t>(op_name.value()), op_val);
}

omni::net::socket_error omni::net::socket::receive(char* buffer, uint32_t len, uint32_t& rcvd)
{
    return this->receive(buffer, len, omni::net::socket_flags::NONE, rcvd);
}

omni::net::socket_error omni::net::socket::receive(int8_t* buffer, uint32_t len, uint32_t& rcvd)
{
    return this->receive(buffer, len, omni::net::socket_flags::NONE, rcvd);
}

omni::net::socket_error omni::net::socket::receive(uint8_t* buffer, uint32_t len, uint32_t& rcvd)
{
    return this->receive(buffer, len, omni::net::socket_flags::NONE, rcvd);
}

omni::net::socket_error omni::net::socket::receive(char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(rcvd);
        WSABUF buf;
        buf.len = len;
        buf.buf = buffer;
        if (::WSARecv(this->m_socket, &buf, 1, &recd, &flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        rcvd = static_cast<uint32_t>(recd);
    #else
        long r = ::recv(this->m_socket, (reinterpret_cast<omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        switch (r) {
            // connection closed
            case 0: return (this->m_last_err = omni::net::socket_error::CONNECTION_RESET);
            // error
            case OMNI_SOCK_SYSERR_FW: return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
            // success
            default: rcvd = r; break;
        }
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::receive(int8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(rcvd);
        WSABUF buf;
        buf.len = len;
        buf.buf = reinterpret_cast<omni::net::xfr_t*>(buffer);
        if (::WSARecv(this->m_socket, &buf, 1, &recd, &flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        rcvd = static_cast<uint32_t>(recd);
    #else
        long r = ::recv(this->m_socket, (reinterpret_cast<omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        switch (r) {
            // connection closed
            case 0: return (this->m_last_err = omni::net::socket_error::CONNECTION_RESET);
            // error
            case OMNI_SOCK_SYSERR_FW: return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
            // success
            default: rcvd = r; break;
        }
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::receive(uint8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(rcvd);
        WSABUF buf;
        buf.len = len;
        buf.buf = reinterpret_cast<omni::net::xfr_t*>(buffer);
        if (::WSARecv(this->m_socket, &buf, 1, &recd, &flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        rcvd = static_cast<uint32_t>(recd);
    #else
        long r = ::recv(this->m_socket, (reinterpret_cast<omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        switch (r) {
            // connection closed
            case 0: return (this->m_last_err = omni::net::socket_error::CONNECTION_RESET);
            // error
            case OMNI_SOCK_SYSERR_FW: return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
            // success
            default: rcvd = r; break;
        }
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::receive_from(char* buffer, uint32_t len, uint32_t& rcvd)
{
    std::string fip;
    uint16_t port;
    return this->receive_from(buffer, len, omni::net::socket_flags::NONE, fip, port, rcvd);
}

omni::net::socket_error omni::net::socket::receive_from(char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& rcvd)
{
    std::string fip;
    uint16_t port;
    return this->receive_from(buffer, len, flags, fip, port, rcvd);
}

omni::net::socket_error omni::net::socket::receive_from(char* buffer, uint32_t len, std::string& from_ip, uint16_t& from_port, uint32_t& rcvd)
{
    return this->receive_from(buffer, len, omni::net::socket_flags::NONE, from_ip, from_port, rcvd);
}

omni::net::socket_error omni::net::socket::receive_from(char* buffer, uint32_t len, omni::net::socket_flags flags, std::string& from_ip, uint16_t& from_port, uint32_t& rcvd)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    omni::net::sockaddr_in_t src_addr;
    OMNI_SOCKLEN_FW addrlen = sizeof(omni::net::sockaddr_in_t);
    std::memset(&src_addr, 0, addrlen);
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(rcvd);
        WSABUF buf;
        buf.len = len;
        buf.buf = reinterpret_cast<omni::net::xfr_t*>(buffer);
        if (::WSARecvFrom(this->m_socket, &buf, 1, &recd, &flag, omni::net::to_sockaddr(src_addr), &addrlen, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        rcvd = static_cast<uint32_t>(recd);
    #else
        long r = ::recvfrom(this->m_socket, (reinterpret_cast<omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags), omni::net::to_sockaddr(src_addr), &addrlen);
        switch (r) {
            // connection closed
            case 0: return (this->m_last_err = omni::net::socket_error::CONNECTION_RESET);
            // error
            case OMNI_SOCK_SYSERR_FW: return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
            // success
            default: rcvd = r; break;
        }
    #endif
    from_ip.assign(inet_ntoa(src_addr.sin_addr));
    from_port = ntohs(src_addr.sin_port);
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::send(const char* buffer, uint32_t len, uint32_t& sent)
{
    return this->send(buffer, len, omni::net::socket_flags::NONE, sent);
}

omni::net::socket_error omni::net::socket::send(const int8_t* buffer, uint32_t len, uint32_t& sent)
{
    return this->send(buffer, len, omni::net::socket_flags::NONE, sent);
}

omni::net::socket_error omni::net::socket::send(const uint8_t* buffer, uint32_t len, uint32_t& sent)
{
    return this->send(buffer, len, omni::net::socket_flags::NONE, sent);
}

omni::net::socket_error omni::net::socket::send(const char* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(sent);
        WSABUF buf;
        buf.len = len;
        buf.buf = const_cast<omni::net::xfr_t*>(reinterpret_cast<const omni::net::xfr_t*>(buffer));
        if (::WSASend(this->m_socket, &buf, 1, &recd, flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        sent = static_cast<uint32_t>(recd);
    #else
        long r = ::send(this->m_socket, (reinterpret_cast<const omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        if (r == OMNI_SOCK_SYSERR_FW) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        // success
        sent = r;
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::send(const int8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(sent);
        WSABUF buf;
        buf.len = len;
        buf.buf = const_cast<omni::net::xfr_t*>(reinterpret_cast<const omni::net::xfr_t*>(buffer));
        if (::WSASend(this->m_socket, &buf, 1, &recd, flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        sent = static_cast<uint32_t>(recd);
    #else
        long r = ::send(this->m_socket, (reinterpret_cast<const omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        if (r == OMNI_SOCK_SYSERR_FW) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        // success
        sent = r;
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::send(const uint8_t* buffer, uint32_t len, omni::net::socket_flags flags, uint32_t& sent)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(sent);
        WSABUF buf;
        buf.len = len;
        buf.buf = const_cast<omni::net::xfr_t*>(reinterpret_cast<const omni::net::xfr_t*>(buffer));
        if (::WSASend(this->m_socket, &buf, 1, &recd, flag, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        sent = static_cast<uint32_t>(recd);
    #else
        long r = ::send(this->m_socket, (reinterpret_cast<const omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags));
        if (r == OMNI_SOCK_SYSERR_FW) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        // success
        sent = r;
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::socket_error omni::net::socket::send_to(const char* buffer, uint32_t len, const std::string& ip, uint16_t port, uint32_t& sent)
{
    return this->send_to(buffer, len, omni::net::socket_flags::NONE, ip, port, sent);
}

omni::net::socket_error omni::net::socket::send_to(const char* buffer, uint32_t len, omni::net::socket_flags flags, const std::string& ip, uint16_t port, uint32_t& sent)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (!this->m_open) {
        return (this->m_last_err = omni::net::socket_error::NOT_INITIALIZED);
    }
    uint32_t ep = 0;
    if (omni::net::util::try_parse_ip4(ip, ep)) {
        return (this->m_last_err = omni::net::socket_error::DESTINATION_ADDRESS_REQUIRED);
    }
    omni::net::sockaddr_in_t to_addr;
    OMNI_SOCKLEN_FW addrlen = sizeof(omni::net::sockaddr_in_t);
    std::memset(&to_addr, 0, addrlen);
    to_addr.sin_family = static_cast<int>(this->m_family);
    to_addr.sin_port = htons(port);
    to_addr.sin_addr.s_addr = htonl(ep);
    #if defined(OMNI_WIN_API)
        DWORD flag = static_cast<int>(flags);
        DWORD recd = static_cast<DWORD>(sent);
        WSABUF buf;
        buf.len = len;
        buf.buf = const_cast<omni::net::xfr_t*>(reinterpret_cast<const omni::net::xfr_t*>(buffer));
        if (::WSASendTo(this->m_socket, &buf, 1, &recd, flag, omni::net::to_sockaddr(to_addr), addrlen, NULL, NULL) == SOCKET_ERROR) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        sent = static_cast<uint32_t>(recd);
    #else
        long r = ::sendto(this->m_socket, (reinterpret_cast<const omni::net::xfr_t*>(buffer)), len, static_cast<int>(flags), omni::net::to_sockaddr(to_addr), addrlen);
        if (r == OMNI_SOCK_SYSERR_FW) {
            return (this->m_last_err = omni::net::parse_error(OMNI_SOCKET_ERR_FW));
        }
        // success
        sent = r;
    #endif
    return (this->m_last_err = omni::net::socket_error::SUCCESS);
}

omni::net::address_family omni::net::socket::address_family() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_family;
}

uint32_t omni::net::socket::endpoint() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_ep4;
}

uint16_t omni::net::socket::port() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_port;
}

uint32_t omni::net::socket::bound_endpoint() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_bep4;
}

uint16_t omni::net::socket::bound_port() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_bport;
}

omni::net::socket_t omni::net::socket::native_handle() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_socket;
}

bool omni::net::socket::is_bound() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_bound;
}

bool omni::net::socket::is_connected() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_connected;
}

bool omni::net::socket::is_open() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_open;
}

bool omni::net::socket::is_shutdown() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_shut;
}

bool omni::net::socket::is_listening() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_listen;
}

omni::net::socket_error omni::net::socket::last_error() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_last_err;
}

omni::net::protocol_type omni::net::socket::protocol() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_proto;
}

omni::net::socket& omni::net::socket::set_address_family(omni::net::address_family family)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (this->m_open) {
        OMNI_ERR_FW("The socket is open", omni::exceptions::socket_exception(static_cast<int>(omni::net::socket_error::IS_CONNECTED)));
    }
    this->m_family = family;
    return *this;
}

omni::net::socket& omni::net::socket::set_protocol_type(omni::net::protocol_type protocol)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (this->m_open) {
        OMNI_ERR_FW("The socket is open", omni::exceptions::socket_exception(static_cast<int>(omni::net::socket_error::IS_CONNECTED)));
    }
    this->m_proto = protocol;
    return *this;
}

omni::net::socket& omni::net::socket::set_socket_type(omni::net::socket_type type)
{
    OMNI_SAFE_SOCKALOCK_FW
    if (this->m_open) {
        OMNI_ERR_FW("The socket is open", omni::exceptions::socket_exception(static_cast<int>(omni::net::socket_error::IS_CONNECTED)));
    }
    this->m_type = type;
    return *this;
}

omni::net::socket_type omni::net::socket::socket_type() const
{
    OMNI_SAFE_SOCKALOCK_FW
    return this->m_type;
}

void omni::net::socket::swap(omni::net::socket& other)
{
    if (this != &other) {
        OMNI_SAFE_SOCKALOCK_FW
        OMNI_SAFE_SOCKOALOCK_FW(other)
        std::swap(this->m_socket, other.m_socket);
        std::swap(this->m_addr, other.m_addr);
        std::swap(this->m_family, other.m_family);
        std::swap(this->m_proto, other.m_proto);
        std::swap(this->m_type, other.m_type);
        std::swap(this->m_last_err, other.m_last_err);
        std::swap(this->m_ep4, other.m_ep4);
        std::swap(this->m_port, other.m_port);
        std::swap(this->m_bep4, other.m_bep4);
        std::swap(this->m_bport, other.m_bport);
        std::swap(this->m_connected, other.m_connected);
        std::swap(this->m_bound, other.m_bound);
        std::swap(this->m_open, other.m_open);
        std::swap(this->m_shut, other.m_shut);
        std::swap(this->m_listen, other.m_listen);
        #if defined(OMNI_OS_WIN)
            this->m_wsa.swap(other.m_wsa);
        #endif
    }
}

omni::string_t omni::net::socket::to_string_t() const
{
    omni::sstream_t s;
    OMNI_SAFE_SOCKLOCK_FW
    s << omni::net::util::to_dotted_ip4_string_t(this->m_ep4) << ":" << this->m_port;
    OMNI_SAFE_SOCKUNLOCK_FW
    return s.str();
}

std::string omni::net::socket::to_string() const
{
    std::stringstream s;
    OMNI_SAFE_SOCKLOCK_FW
    s << omni::net::util::to_dotted_ip4_string(this->m_ep4) << ":" << this->m_port;
    OMNI_SAFE_SOCKUNLOCK_FW
    return s.str();
}

std::wstring omni::net::socket::to_wstring() const
{
    std::wstringstream s;
    OMNI_SAFE_SOCKLOCK_FW
    s << omni::net::util::to_dotted_ip4_wstring(this->m_ep4) << ":" << this->m_port;
    OMNI_SAFE_SOCKUNLOCK_FW
    return s.str();
}