BamDNS.h

/*
 * COPYRIGHT: Real Time Logic LLC, 2026
 *
 * This software is copyrighted by and is the sole property of Real
 * Time Logic LLC. All rights, title, ownership, or other interests in
 * the software remain the property of Real Time Logic LLC. This
 * software may only be used in accordance with the terms and
 * conditions stipulated in the corresponding license agreement under
 * which the software has been supplied. Any unauthorized use,
 * duplication, transmission, distribution, or disclosure of this
 * software is expressly forbidden.
 *
 * This Copyright notice may not be removed or modified without prior
 * written consent of Real Time Logic LLC.
 * Real Time Logic LLC reserves the right to modify this software
 * without notice. https://realtimelogic.com
 */
 
#ifndef _BamDNS_h
#define _BamDNS_h
 
#include <SoDispCon.h>
#include <BaTimer.h>
 
typedef struct
{
   U32 ifIndex4;
   U8 addr4[4];
   U8 prefix4;
#ifdef USE_IPV6
   U32 ifIndex6;
   U8 addr6[16];
   U8 prefix6;
#endif
} BamDNS_NetInfo;
 
typedef struct
{
   const char* name; 
   const BamDNS_NetInfo* netInfo; 
} BamDNS_Config;
 
struct BamDNS;
 
/* Private storage and socket-port contract. Applications must not use these
 * members. No native socket structures or Lua types occur in native storage.
 */
typedef struct
{
   HttpSockaddr addr;
   U16 port;
   BaBool multicast;
} BamDNS_Peer;
 
typedef struct
{
   SoDispCon con; /* First: receive callback casts back to this structure. */
   struct BamDNS* owner;
   void (*portData[2])(void); /* Opaque socket-port function pointers. */
   BamDNS_Peer tcPeer;
   U32 due, tcDue, lastSend;
   U8 pending, tcPending, retries;
   BaBool ipv6;
} BamDNS_Channel;
 
typedef struct BamDNS
{
#ifdef __cplusplus
   BamDNS(SoDisp* disp, BaTimer* timer, const BamDNS_Config* cfg);
   ~BamDNS();
   int status() const;
#endif
   /* Private implementation storage, public only to permit caller allocation. */
   BamDNS_Channel channel[
#ifdef USE_IPV6
      2
#else
      1
#endif
   ];
   BamDNS_NetInfo net;
   BaTimer* timer;
   struct BamDNS_Timer* timerCtx;
   size_t timerKey;
   U32 announceDue, timerDue, refreshDue;
   int result;
   U8 name[71]; /* Length label + 63 bytes + length/local/root. */
   U8 nameLen, records, announcements;
   BaBool automatic;
#ifdef __cplusplus
private:
   BamDNS(const BamDNS&);
   BamDNS& operator=(const BamDNS&);
#endif
} BamDNS;
 
#ifdef __cplusplus
extern "C" {
#endif
 
BA_API void BamDNS_constructor(BamDNS* o, SoDisp* disp, BaTimer* timer,
                               const BamDNS_Config* cfg);
BA_API int BamDNS_status(const BamDNS* o);
BA_API void BamDNS_destructor(BamDNS* o);
 
BA_API int BamDNS_getNetInfo(BamDNS_NetInfo* net);
 
#ifdef BAS_LOADED
struct lua_State;
BA_API void BamDNS_luaopen(struct lua_State* L,
                          const BamDNS_NetInfo* netInfo);
#endif
 
/* Port implementers only; supplied BSD implementation is in
 * src/arch/bsdSocket/BamDNS-Sock.c. setup configures and binds an open socket;
 * returns 0, E_BIND, or -1. recv returns byte count,
 * 0 for a discarded packet, -2 for would-block, -1 for a local error.
 * send returns byte count, -2 for would-block, -1 for a local error.
 * All operations must be nonblocking. NULL send peer selects multicast.
 */
int BamDNS_socketSetup(BamDNS_Channel* c, const BamDNS_NetInfo* net);
int BamDNS_socketRecv(BamDNS_Channel* c, const BamDNS_NetInfo* net,
                     void* data, int size, BamDNS_Peer* peer);
int BamDNS_socketSend(BamDNS_Channel* c, const BamDNS_NetInfo* net,
                     const void* data, int size, const BamDNS_Peer* peer);
 
#ifdef __cplusplus
}
inline BamDNS::BamDNS(SoDisp* disp, BaTimer* timer, const BamDNS_Config* cfg)
{ BamDNS_constructor(this, disp, timer, cfg); }
inline BamDNS::~BamDNS() { BamDNS_destructor(this); }
inline int BamDNS::status() const { return BamDNS_status(this); }
#endif
 
#endif