src/lib/openjpip/session_manager.h

   1 /*
   2  * $Id$
   3  *
   4  * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2014, Professor Benoit Macq
   6  * Copyright (c) 2010-2011, Kaori Hagihara
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef     SESSION_MANAGER_H_
  32 # define    SESSION_MANAGER_H_
  33
  34 #include "channel_manager.h"
  35 #include "cachemodel_manager.h"
  36
  37 /** Session parameters*/
  38 typedef struct session_param {
  39     channellist_param_t *channellist;        /**< channel list pointer*/
  40     cachemodellist_param_t *cachemodellist;  /**< cache list pointer*/
  41     struct session_param *next;              /**< pointer to the next session*/
  42 } session_param_t;
  43
  44 /** Session list parameters*/
  45 typedef struct sessionlist_param {
  46     session_param_t *first; /**< first session pointer of the list*/
  47     session_param_t *last;  /**< last  session pointer of the list*/
  48 } sessionlist_param_t;
  49
  50
  51 /**
  52  * generate a session list
  53  *
  54  * @return pointer to the generated session list
  55  */
  56 sessionlist_param_t * gene_sessionlist(void);
  57
  58
  59 /**
  60  * generate a session under the sesion list
  61  *
  62  * @param[in] sessionlist session list to insert the new session
  63  * @return                pointer to the generated session
  64  */
  65 session_param_t * gene_session(sessionlist_param_t *sessionlist);
  66
  67 /**
  68  * search a channel and its belonging session by channel ID
  69  *
  70  * @param[in]     cid           channel identifier
  71  * @param[in]     sessionlist   session list pointer
  72  * @param[in,out] foundsession  address of the found session pointer
  73  * @param[in,out] foundchannel  address of the found channel pointer
  74  * @return                      if the channel is found (true) or not (false)
  75  */
  76 OPJ_BOOL search_session_and_channel(char cid[],
  77                                     sessionlist_param_t *sessionlist,
  78                                     session_param_t **foundsession,
  79                                     channel_param_t **foundchannel);
  80
  81 /**
  82  * insert a cache model into a session
  83  *
  84  * @param[in] session    session pointer
  85  * @param[in] cachemodel cachemodel pointer
  86  */
  87 void insert_cachemodel_into_session(session_param_t *session,
  88                                     cachemodel_param_t *cachemodel);
  89
  90
  91 /**
  92  * delete a session
  93  *
  94  * @param[in] session     address of the session pointer
  95  * @param[in] sessionlist session list pointer
  96  * @return                    if succeeded (true) or failed (false)
  97  */
  98 OPJ_BOOL delete_session(session_param_t **session,
  99                         sessionlist_param_t *sessionlist);
 100
 101
 102 /**
 103  * delete session list
 104  *
 105  * @param[in,out] sessionlist address of the session list pointer
 106  */
 107 void delete_sessionlist(sessionlist_param_t **sessionlist);
 108
 109 /**
 110  * print all sessions
 111  *
 112  * @param[in] sessionlist session list pointer
 113  */
 114 void print_allsession(sessionlist_param_t *sessionlist);
 115
 116
 117 #endif      /* !SESSION_MANAGER_H_ */