ssdp_common.hpp

Go to the documentation of this file.

#if defined(COMPA_HAVE_CTRLPT_SSDP) || defined(COMPA_HAVE_DEVICE_SSDP)
 
#ifndef COMPA_SSDP_COMMON_HPP
#define COMPA_SSDP_COMMON_HPP
/**************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (C) 2011-2012 France Telecom All rights reserved.
 * Copyright (C) 2022+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-06-12
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 INTEL OR
 * 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.
 *
 **************************************************************************/
// Last compare with ./pupnp source file on 2023-08-30, ver 1.14.18
#include <miniserver.hpp>
 
 
inline constexpr size_t ERROR_BUFFER_LEN{256};
 
#define BUFSIZE (size_t)2500
#define SSDP_IP "239.255.255.250"
#define SSDP_IPV6_LINKLOCAL "FF02::C"
#define SSDP_IPV6_SITELOCAL "FF05::C"
#define SSDP_PORT 1900
#define NUM_TRY 3
#define THREAD_LIMIT 50
#define COMMAND_LEN 300
 
#define NO_ERROR_FOUND 0
#define E_REQUEST_INVALID -3
#define E_RES_EXPIRED -4
#define E_MEM_ALLOC -5
#define E_HTTP_SYNTEX -6
#define E_SOCKET -7
 
#define RQST_TIMEOUT 20
 
enum SsdpSearchType {
    SSDP_SERROR = -1, 
    SSDP_ALL,         
    SSDP_ROOTDEVICE,  
    SSDP_DEVICEUDN,   
    SSDP_DEVICETYPE,  
    SSDP_SERVICE      
};
 
struct SsdpEvent {
    enum SsdpSearchType RequestType;
    int ErrCode;
    int MaxAge;
    int Mx;
    char UDN[LINE_SIZE];
    char DeviceType[LINE_SIZE];
    /* NT or ST */
    char ServiceType[LINE_SIZE];
    char Location[LINE_SIZE];
    char HostAddr[LINE_SIZE];
    char Os[LINE_SIZE];
    char Ext[LINE_SIZE];
    char Date[LINE_SIZE];
    struct sockaddr* DestAddr;
    void* Cookie;
};
 
typedef void (*SsdpFunPtr)(SsdpEvent*);
 
struct ThreadData {
    int Mx;
    void* Cookie;
    char* Data;
    struct sockaddr_storage DestAddr;
};
 
struct SsdpSearchReply {
    int MaxAge;
    UpnpDevice_Handle handle;
    struct sockaddr_storage dest_addr;
    SsdpEvent event;
};
 
struct SsdpSearchExpArg {
    int handle;         
    int timeoutEventId; 
};
 
struct ssdp_thread_data {
    http_parser_t parser;       
    sockaddr_storage dest_addr; 
};
 
/* globals */
 
inline SOCKET gSsdpReqSocket4;
#ifdef UPNP_ENABLE_IPV6
inline SOCKET gSsdpReqSocket6;
#endif /* UPNP_ENABLE_IPV6 */
 
typedef int (*ParserFun)(char*, SsdpEvent*);
 
 
int unique_service_name(
    char* cmd,
    SsdpEvent* Evt);
 
SsdpSearchType ssdp_request_type1(
    char* cmd);
 
int ssdp_request_type(
    char* cmd,
    SsdpEvent* Evt);
 
int readFromSSDPSocket(
    SOCKET socket);
 
int get_ssdp_sockets(
    MiniServerSockArray* out);
 
 
#endif /* COMPA_SSDP_COMMON_HPP */
#endif // defined(COMPA_HAVE_CTRLPT_SSDP) || defined(COMPA_HAVE_DEVICE_SSDP)