service_table.hpp

Go to the documentation of this file.

#ifndef COMPA_SERVICE_TABLE_HPP
#define COMPA_SERVICE_TABLE_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * All rights reserved.
 * Copyright (c) 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: 2024-03-02
 *
 * 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.
 *
 ******************************************************************************/
#include <config.hpp>
 
#include <LinkedList.hpp>
#include <upnpdebug.hpp>
#include <uri.hpp>
 
#define SID_SIZE (size_t)41
 
struct subscription {
    Upnp_SID sid;
    int ToSendEventKey;
    time_t expireTime;
    int active;
    URL_list DeliveryURLs;
 
    LinkedList outgoing;
    struct subscription* next; 
};
 
struct service_info {
    DOMString serviceType;
    DOMString serviceId;
    char* SCPDURL;
    char* controlURL;
    char* eventURL;
    DOMString UDN;
    int active;
    int TotalSubscriptions;
    subscription* subscriptionList;
    struct service_info* next;
};
 
#ifdef COMPA_HAVE_DEVICE_SSDP
 
void freeSubscriptionQueuedEvents(subscription* sub);
 
struct service_table {
    DOMString URLBase;
    service_info* serviceList;
    service_info* endServiceList;
};
 
/* Functions for Subscriptions */
 
#ifdef COMPA_HAVE_DEVICE_GENA
int copy_subscription(
    subscription* in,
    subscription* out);
 
void RemoveSubscriptionSID(
    Upnp_SID sid,
    service_info* service);
 
subscription* GetSubscriptionSID(
    const Upnp_SID sid,
    service_info* service);
 
subscription* GetFirstSubscription(
    service_info* service);
 
subscription* GetNextSubscription(
    service_info* service,
    subscription* current);
 
void freeSubscription(
    subscription* sub);
 
void freeSubscriptionList(
    subscription* head);
 
service_info* FindServiceId(
    service_table* table,
    const char* serviceId,
    const char* UDN);
 
#endif /* COMPA_HAVE_DEVICE_GENA */
 
service_info* FindServiceEventURLPath(
    service_table* table,
    const char* eventURLPath);
 
service_info* FindServiceControlURLPath(
    service_table* table,
    const char* controlURLPath);
 
#ifdef DEBUG
void printService(
    service_info* service,
    Upnp_LogLevel level,
    Dbg_Module module);
#else
#define printService(service, level, module)                                   \
    do {                                                                       \
    } while (0)
#endif
 
#ifdef DEBUG
void printServiceList(
    service_info* service,
    Upnp_LogLevel level,
    Dbg_Module module);
#else
#define printServiceList(service, level, module)                               \
    do {                                                                       \
    } while (0)
#endif
 
#ifdef DEBUG
void printServiceTable(
    service_table* table,
    Upnp_LogLevel level,
    Dbg_Module module);
#else
#define printServiceTable(table, level, module)                                \
    do {                                                                       \
    } while (0)
#endif
 
#ifdef COMPA_HAVE_DEVICE_GENA
void freeService(
    service_info* in);
 
void freeServiceList(
    service_info* head);
 
void freeServiceTable(
    service_table* table);
 
int removeServiceTable(
    IXML_Node* node,
    service_table* in);
 
int addServiceTable(
    IXML_Node* node,
    service_table* in,
    const char* DefaultURLBase);
 
int getServiceTable(
    IXML_Node* node,
    service_table* out,
    const char* DefaultURLBase);
 
/*  Misc helper functions   */
 
DOMString getElementValue(
    IXML_Node* node);
 
int getSubElement(
    const char* element_name,
    IXML_Node* node,
    IXML_Node** out);
 
#endif /* COMPA_HAVE_DEVICE_GENA */
#endif /* COMPA_HAVE_DEVICE_SSDP */
#endif /* COMPA_SERVICE_TABLE_HPP */