BlurrrNetworkServiceDiscovery.h

Go to the documentation of this file.

#ifndef BLURRR_ZEROCONF_H
#define BLURRR_ZEROCONF_H

#ifdef __cplusplus
extern "C" {
#endif


#ifndef DOXYGEN_SHOULD_IGNORE_THIS

        /* Note: For Doxygen to produce clean output, you should set the 
         * PREDEFINED option to remove DECLSPEC, CALLCONVENTION, and
         * the DOXYGEN_SHOULD_IGNORE_THIS blocks.
         * PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 DECLSPEC= CALLCONVENTION=
         */
        
#ifdef BLURRRZEROCONF_BUILD_LIBRARY
        #ifdef WIN32
                #define BLURRRZEROCONF_EXPORT __declspec(dllexport)
        #elif defined(__GNUC__) && __GNUC__ >= 4
                #define BLURRRZEROCONF_EXPORT __attribute__ ((visibility("default")))
        #else
                #define BLURRRZEROCONF_EXPORT
        #endif
#else
        #define BLURRRZEROCONF_EXPORT
#endif /* BLURRRZEROCONF_BUILD_LIBRARY */


    /*
        Nullability qualifiers: currently only supported by Clang.
     */
    #if defined(__clang__)
        #if __has_feature(nullability)
            #define BNSD_NONNULL _Nonnull
            #define BNSD_NULLABLE _Nullable
        #else
            #define BNSD_NONNULL
            #define BNSD_NULLABLE
        #endif
    #else
        #define BNSD_NONNULL
        #define BNSD_NULLABLE
    #endif



#endif /* DOXYGEN_SHOULD_IGNORE_THIS */

/* Visual Studio 2013 *finally* has <stdint.h> */
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>


enum
{
    BNSD_ERR_OK = 0, 
    BNSD_ERR_RESOLVE_TIMEOUT = 1, 
    BNSD_ERR_FAILURE = -1, 
    BNSD_ERR_BAD_STATE = -2,                
    BNSD_ERR_INVALID_HOST_NAME = -3,        
    BNSD_ERR_INVALID_DOMAIN_NAME = -4,      
    BNSD_ERR_NO_NETWORK = -5,               
    BNSD_ERR_INVALID_TTL = -6,              
    BNSD_ERR_IS_PATTERN = -7,               
    BNSD_ERR_COLLISION = -8,                
    BNSD_ERR_INVALID_RECORD = -9,           
    BNSD_ERR_INVALID_SERVICE_NAME = -10,    
    BNSD_ERR_INVALID_SERVICE_TYPE = -11,    
    BNSD_ERR_INVALID_PORT = -12,            
    BNSD_ERR_INVALID_KEY = -13,             
    BNSD_ERR_INVALID_ADDRESS = -14,         
    BNSD_ERR_TIMEOUT = -15,
    BNSD_ERR_TOO_MANY_CLIENTS = -16,        
    BNSD_ERR_TOO_MANY_OBJECTS = -17,        
    BNSD_ERR_TOO_MANY_ENTRIES = -18,        
    BNSD_ERR_OS = -19,                      
    BNSD_ERR_ACCESS_DENIED = -20,           
    BNSD_ERR_INVALID_OPERATION = -21,       
    BNSD_ERR_DBUS_ERROR = -22,              
    BNSD_ERR_DISCONNECTED = -23,            
    BNSD_ERR_NO_MEMORY = -24,               
    BNSD_ERR_INVALID_OBJECT = -25,          
    BNSD_ERR_NO_DAEMON = -26,               
    BNSD_ERR_INVALID_INTERFACE = -27,       
    BNSD_ERR_INVALID_PROTOCOL = -28,        
    BNSD_ERR_INVALID_FLAGS = -29,           
    BNSD_ERR_NOT_FOUND = -30,               
    BNSD_ERR_INVALID_CONFIG = -31,          
    BNSD_ERR_VERSION_MISMATCH = -32,        
    BNSD_ERR_INVALID_SERVICE_SUBTYPE = -33, 
    BNSD_ERR_INVALID_PACKET = -34,          
    BNSD_ERR_INVALID_DNS_ERROR = -35,       
    BNSD_ERR_DNS_FORMERR = -36,             
    BNSD_ERR_DNS_SERVFAIL = -37,            
    BNSD_ERR_DNS_NXDOMAIN = -38,            
    BNSD_ERR_DNS_NOTIMP = -39,              
    BNSD_ERR_DNS_REFUSED = -40,             
    BNSD_ERR_DNS_YXDOMAIN = -41,
    BNSD_ERR_DNS_YXRRSET = -42,
    BNSD_ERR_DNS_NXRRSET = -43,
    BNSD_ERR_DNS_NOTAUTH = -44,             
    BNSD_ERR_DNS_NOTZONE = -45,
    BNSD_ERR_INVALID_RDATA = -46,           
    BNSD_ERR_INVALID_DNS_CLASS = -47,       
    BNSD_ERR_INVALID_DNS_TYPE = -48,        
    BNSD_ERR_NOT_SUPPORTED = -49,           
    BNSD_ERR_NOT_PERMITTED = -50,           
    BNSD_ERR_INVALID_ARGUMENT = -51,        
    BNSD_ERR_IS_EMPTY = -52,                
    BNSD_ERR_NO_CHANGE = -53,               
    BNSD_ERR_INVALID_NAME = -54,
    BNSD_ERR_NOT_INITIALIZED = -55,
    BNSD_ERR_ALREADY_EXISTS = -56,
    BNSD_ERR_FIREWALL = -57,
    BNSD_ERR_NATTRAVERSAL = -58,
    BNSD_ERR_DOUBLENAT = -59,
    BNSD_ERR_BAD_TIME = -60,
    BNSD_ERR_INVALID_PARAMETERS = -61,      
    BNSD_ERR_MAX = -62 // Always update when adding more
};

enum 
{
    BNSD_FLAGSCB_MORECOMING = 0x1 
};

enum 
{
    BNSD_FLAGS_INCLUDE_BLUETOOTH = 0x1 
};


struct BNSD_Registration;
struct BNSD_Discovery;
struct BNSD_Resolve;

typedef struct BNSD_Registration BNSD_Registration;
typedef struct BNSD_Discovery BNSD_Discovery;
typedef struct BNSD_Resolve BNSD_Resolve;

BLURRRZEROCONF_EXPORT bool BNSD_IsSupported(void);

BLURRRZEROCONF_EXPORT bool BNSD_Init(void* BNSD_NULLABLE platform_init_object);
BLURRRZEROCONF_EXPORT void BNSD_Quit(void);

BLURRRZEROCONF_EXPORT const char* BNSD_NONNULL BNSD_GetBackendDescription(void);

BLURRRZEROCONF_EXPORT char* BNSD_NONNULL BNSD_CreateDeviceNameString(void);
BLURRRZEROCONF_EXPORT void BNSD_FreeString(char* BNSD_NULLABLE str);
BLURRRZEROCONF_EXPORT size_t BNSD_GetDeviceNameString(char* BNSD_NULLABLE string_array, size_t array_length);




typedef void (*BNSD_RegisterCallback)(struct BNSD_Registration* BNSD_NONNULL zeroconf_registration, const char* BNSD_NONNULL service_name, const char* BNSD_NONNULL service_type, const char* BNSD_NONNULL domain, int32_t blurrr_error_code, uint32_t flags, void* BNSD_NULLABLE user_data);

typedef void (*BNSD_DiscoveryCallback)(struct BNSD_Discovery* BNSD_NONNULL zeroconf_discovery, const char* BNSD_NONNULL service_name, const char* BNSD_NONNULL service_type, const char* BNSD_NONNULL domain, bool is_added, int32_t blurrr_error_code, uint32_t flags, int32_t interface_index, void* BNSD_NULLABLE user_data);

typedef void (*BNSD_ResolveCallback)(struct BNSD_Resolve* BNSD_NONNULL zeroconf_resolve, const char* BNSD_NONNULL service_name, const char* BNSD_NONNULL service_type, const char* BNSD_NONNULL domain, const char* BNSD_NONNULL full_name, const char* BNSD_NONNULL host_target, uint16_t port, const char* BNSD_NULLABLE txt_record, uint16_t txt_record_length, int32_t blurrr_error_code, uint32_t flags, int32_t interface_index, void* BNSD_NULLABLE user_data);


BLURRRZEROCONF_EXPORT struct BNSD_Registration* BNSD_NULLABLE BNSD_RegisterService(const char* BNSD_NULLABLE service_name, const char* BNSD_NONNULL service_type, const char* BNSD_NULLABLE domain, const char* BNSD_NULLABLE host_name, uint16_t port, uint32_t flags, const char* BNSD_NULLABLE txt_record, uint16_t txt_record_length, BNSD_RegisterCallback BNSD_NONNULL callback_function, void* BNSD_NULLABLE user_data);
BLURRRZEROCONF_EXPORT void BNSD_UnregisterService(struct BNSD_Registration* BNSD_NULLABLE registration_service);

BLURRRZEROCONF_EXPORT struct BNSD_Discovery* BNSD_NULLABLE BNSD_StartDiscovery(const char* BNSD_NONNULL service_type, const char* BNSD_NULLABLE domain, uint32_t flags, BNSD_DiscoveryCallback BNSD_NONNULL callback_function, void* BNSD_NULLABLE user_data);
BLURRRZEROCONF_EXPORT void BNSD_StopDiscovery(struct BNSD_Discovery* BNSD_NULLABLE discovery_service);

BLURRRZEROCONF_EXPORT struct BNSD_Resolve* BNSD_NULLABLE BNSD_StartResolve(const char* BNSD_NONNULL service_name, const char* BNSD_NONNULL service_type, const char* BNSD_NULLABLE domain, uint32_t flags, uint32_t time_out, BNSD_ResolveCallback BNSD_NONNULL callback_function, void* BNSD_NULLABLE user_data);
BLURRRZEROCONF_EXPORT void BNSD_StopResolve(struct BNSD_Resolve* BNSD_NULLABLE resolve_service);




#ifdef __cplusplus
}
#endif

#endif /* BLURRR_ZEROCONF_H */