Code convergence for client_table (ClientSubscription).
git-svn-id: https://pupnp.svn.sourceforge.net/svnroot/pupnp/branches/branch-1.6.x@539 119443c7-1b9e-41f8-b6fc-b9c35fce742c
This commit is contained in:
Marcelo Roberto Jimenez
@@ -1,166 +1,248 @@
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
//
|
||||
// Copyright (c) 2000-2003 Intel Corporation
|
||||
// All rights reserved.
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef _CLIENT_TABLE
|
||||
#define _CLIENT_TABLE
|
||||
#ifndef CLIENT_TABLE_H
|
||||
#define CLIENT_TABLE_H
|
||||
|
||||
|
||||
/*!
|
||||
* \file
|
||||
*/
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
|
||||
#include "service_table.h"
|
||||
#include "upnp.h"
|
||||
#include "UpnpString.h"
|
||||
#include "upnp_timeout.h"
|
||||
#include "uri.h"
|
||||
#include "TimerThread.h"
|
||||
|
||||
|
||||
#include <stdio.h>
|
||||
//#include <malloc.h>
|
||||
#include <stdlib.h>
|
||||
#include <time.h>
|
||||
#include "uri.h"
|
||||
#include "service_table.h"
|
||||
|
||||
#include "TimerThread.h"
|
||||
#include "upnp_timeout.h"
|
||||
|
||||
extern TimerThread gTimerThread;
|
||||
|
||||
CLIENTONLY(
|
||||
typedef struct CLIENT_SUBSCRIPTION {
|
||||
Upnp_SID sid;
|
||||
char * ActualSID;
|
||||
char * EventURL;
|
||||
int RenewEventId;
|
||||
struct CLIENT_SUBSCRIPTION *next;
|
||||
} ClientSubscription;
|
||||
|
||||
/************************************************************************
|
||||
* Function : copy_client_subscription
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription * in ; - source client subscription
|
||||
* ClientSubscription * out ; - destination client subscription
|
||||
*
|
||||
* Description : Make a copy of the client subscription data
|
||||
*
|
||||
* Return : int ;
|
||||
* UPNP_E_OUTOF_MEMORY - On Failure to allocate memory
|
||||
* HTTP_SUCCESS - On Success
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
int copy_client_subscription(ClientSubscription * in, ClientSubscription * out);
|
||||
|
||||
/************************************************************************
|
||||
* Function : free_client_subscription
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription * sub ; - Client subscription to be freed
|
||||
*
|
||||
* Description : Free memory allocated for client subscription data.
|
||||
* Remove timer thread associated with this subscription event.
|
||||
*
|
||||
* Return : void ;
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
void free_client_subscription(ClientSubscription * sub);
|
||||
#ifdef INCLUDE_CLIENT_APIS
|
||||
|
||||
|
||||
/************************************************************************
|
||||
* Function : freeClientSubList
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription * list ; Client subscription
|
||||
*
|
||||
* Description : Free the client subscription table.
|
||||
*
|
||||
* Return : void ;
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
void freeClientSubList(ClientSubscription * list);
|
||||
typedef struct s_ClientSubscription ClientSubscription;
|
||||
|
||||
/************************************************************************
|
||||
* Function : RemoveClientSubClientSID
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription **head ; Head of the subscription list
|
||||
* const Upnp_SID sid ; Subscription ID to be mactched
|
||||
*
|
||||
* Description : Remove the client subscription matching the
|
||||
* subscritpion id represented by the const Upnp_SID sid parameter
|
||||
* from the table and update the table.
|
||||
*
|
||||
* Return : void ;
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
void RemoveClientSubClientSID(ClientSubscription **head,
|
||||
const Upnp_SID sid);
|
||||
|
||||
/************************************************************************
|
||||
* Function : GetClientSubClientSID
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription *head ; Head of the subscription list
|
||||
* const Upnp_SID sid ; Subscription ID to be matched
|
||||
*
|
||||
* Description : Return the client subscription from the client table
|
||||
* that matches const Upnp_SID sid subscrition id value.
|
||||
*
|
||||
* Return : ClientSubscription * ; The matching subscription
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
ClientSubscription * GetClientSubClientSID(ClientSubscription *head
|
||||
, const Upnp_SID sid);
|
||||
/*!
|
||||
* \brief Constructor.
|
||||
*/
|
||||
ClientSubscription *UpnpClientSubscription_new();
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Destructor.
|
||||
*/
|
||||
void UpnpClientSubscription_delete(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Copy Constructor.
|
||||
*/
|
||||
ClientSubscription *UpnpClientSubscription_dup(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Assignment operator.
|
||||
*/
|
||||
void UpnpClientSubscription_assign(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *q,
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
int UpnpClientSubscription_get_RenewEventId(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_set_RenewEventId(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
/*! [in] . */
|
||||
int n);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
const UpnpString *UpnpClientSubscription_get_SID(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_set_SID(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const UpnpString *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_strcpy_SID(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const char *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
const UpnpString *UpnpClientSubscription_get_ActualSID(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_set_ActualSID(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const UpnpString *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_strcpy_ActualSID(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const char *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
const UpnpString *UpnpClientSubscription_get_EventURL(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_set_EventURL(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const UpnpString *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_strcpy_EventURL(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
const char *s);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
ClientSubscription *UpnpClientSubscription_get_Next(
|
||||
/*! [in] The \b this pointer. */
|
||||
const ClientSubscription *p);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief
|
||||
*/
|
||||
void UpnpClientSubscription_set_Next(
|
||||
/*! [in] The \b this pointer. */
|
||||
ClientSubscription *p,
|
||||
ClientSubscription *q);
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Free memory allocated for client subscription data.
|
||||
*
|
||||
* Remove timer thread associated with this subscription event.
|
||||
*/
|
||||
void free_client_subscription(
|
||||
/*! [in] Client subscription to be freed. */
|
||||
ClientSubscription *sub);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Free the client subscription table.
|
||||
*/
|
||||
void freeClientSubList(
|
||||
/*! [in] Client subscription list to be freed. */
|
||||
ClientSubscription *list);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Remove the client subscription matching the subscritpion id
|
||||
* represented by the const Upnp_SID sid parameter from the table and
|
||||
* update the table.
|
||||
*/
|
||||
void RemoveClientSubClientSID(
|
||||
/*! [in] Head of the subscription list. */
|
||||
ClientSubscription **head,
|
||||
/*! [in] Subscription ID to be mactched. */
|
||||
const UpnpString *sid);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Return the client subscription from the client table that matches
|
||||
* const Upnp_SID sid subscrition id value.
|
||||
*
|
||||
* \return The matching subscription.
|
||||
*/
|
||||
ClientSubscription *GetClientSubClientSID(
|
||||
/*! [in] Head of the subscription list. */
|
||||
ClientSubscription *head,
|
||||
/*! [in] Subscription ID to be mactched. */
|
||||
const UpnpString *sid);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Returns the client subscription from the client subscription table
|
||||
* that has the matching token *sid buffer value.
|
||||
*
|
||||
* \return The matching subscription.
|
||||
*/
|
||||
ClientSubscription *GetClientSubActualSID(
|
||||
/*! [in] Head of the subscription list. */
|
||||
ClientSubscription *head,
|
||||
/*! [in] Subscription ID to be mactched. */
|
||||
token *sid);
|
||||
|
||||
|
||||
#endif /* INCLUDE_CLIENT_APIS */
|
||||
|
||||
/************************************************************************
|
||||
* Function : GetClientSubActualSID
|
||||
*
|
||||
* Parameters :
|
||||
* ClientSubscription *head ; Head of the subscription list
|
||||
* token * sid ; Subscription ID to be matched
|
||||
*
|
||||
* Description : Returns the client subscription from the client
|
||||
* subscription table that has the matching token * sid buffer
|
||||
* value.
|
||||
*
|
||||
* Return : ClientSubscription * ; The matching subscription
|
||||
*
|
||||
* Note :
|
||||
************************************************************************/
|
||||
ClientSubscription * GetClientSubActualSID(ClientSubscription *head, token * sid);
|
||||
)
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
#endif /* __cplusplus */
|
||||
|
||||
|
||||
#endif /* CLIENT_TABLE_H */
|
||||
|
||||
#endif /* _CLIENT_TABLE */
|
||||
|
||||
Reference in New Issue
Block a user