BSocket.h

Go to the documentation of this file.

/*******************************************************************************
 *  BSocket.h   BSocket Access Classes
 *  T.Barnaby,  BEAM Ltd,   1/4/05
 *  Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
 *  For license see LICENSE.txt at the root of the beamlib source tree.
 *******************************************************************************
 */
#ifndef BSOCKET_H
#define BSOCKET_H   1
 
#include <BString.h>
#include <BError.h>
#include <BTypes.h>
#include <stdint.h>
#include <sys/types.h>
 
#if TARGET_win32 || TARGET_win64
#include <winsock2.h>
#else
#ifdef __linux__
#include <sys/prctl.h>
#else
#include <netinet/in.h>
#define SOL_IP  0
#define SO_PRIORITY 12
#define MSG_NOSIGNAL 0
#endif
#endif
 
class BSocketAddress {
public:
    typedef struct sockaddr SockAddr;
    
            BSocketAddress();
            BSocketAddress(const BSocketAddress& add);
            BSocketAddress(SockAddr* address, int len);
            ~BSocketAddress();
            
    BError      set(SockAddr* address, int len);
 
    const SockAddr* raw() const;
    int     len() const;
    
    BString     getString() const;              
    
            // Operator functions
    BSocketAddress& operator=(const BSocketAddress& add);
            operator const SockAddr*() const { return raw(); }
    int     operator==(const BSocketAddress& add) const;
    int     operator!=(const BSocketAddress& add) const;
private:
    int     olen;
    SockAddr*   oaddress;
};
 
class BSocketAddressINET : public BSocketAddress {
public:
    typedef struct sockaddr_in SockAddrIP;
 
    BError      set(BString hostName, uint32_t port);
    BError      set(uint32_t address, uint32_t port);
    BError      set(BString hostName, BString service, BString type);
 
    void        setPort(uint32_t port);
    uint32_t    address();              
    uint32_t    port();                 
    
    BString     getString();                
    
    // Some useful generic system functions
    static BString      getHostName();          
    static BList<uint32_t>  getIpAddresses();       
    static BList<BString>   getIpAddressList();     
    static BList<BString>   getIpAddressListAll();      
};
 
class BSocket {
public:
    enum NType  { STREAM, DGRAM };
    enum Priority   { PriorityLow, PriorityNormal, PriorityHigh };
 
            BSocket();
            BSocket(int fd);
            BSocket(NType type);
            BSocket(int domain, int type, int protocol);
            ~BSocket();
 
    BError      init(int domain, int type, int protocol);
    BError      init(NType type);
    void        setFd(int fd);
    int     getFd();
 
            // Main functions   
    BError      bind(const BSocketAddress& add);
    BError      connect(const BSocketAddress& add);
    BError      shutdown(int how);
    BError      close();
    BError      listen(int backlog = 5);
    BError      accept(int& fd);
    BError      accept(int& fd, BSocketAddress& address);
        
            // Main data transfer functions
    BError      send(const void* buf, BSize nbytes, BSize& nbytesSent, int flags = 0);
    BError      sendTo(const BSocketAddress& address, const void* buf, BSize nbytes, BSize& nbytesSent, int flags = 0);
    BError      sendChunks(const BDataChunk* chunks, BSize nChunks, BSize& nbytesSent, int flags = 0);
    BError      recv(void* buf, BSize maxbytes, BSize& nbytesRecv, int flags = 0);
    BError      recvFrom(BSocketAddress& address, void* buf, BSize maxbytes, BSize& nbytesRecv, int flags = 0);
    BError      recvWithTimeout(void* buf, BSize maxbytes, BSize& nbytesRecv, int timeout, int flags = 0);
    BError      recvFromWithTimeout(BSocketAddress& address, void* buf, BSize maxbytes, BSize& nbytesRecv, int timeout, int flags = 0);
 
    BUInt       recvAvailable();
 
            // Configuration functions
    BError      setSockOpt(int level, int optname, void* optval, unsigned int optlen);
    BError      getSockOpt(int level, int optname, void* optval, unsigned int* optlen);
    BError      setReuseAddress(int on);
    BError      setBroadCast(int on);
    BError      setPriority(Priority priority);
    
    BError      getMTU(uint32_t& mtu);
    BError      getAddress(BSocketAddress& address);
 
private:
    int     osocket;
};
#endif