applications/jpip/libopenjpip/target_manager.h

   1 /*
   2  * $Id: target_manager.h 44 2011-02-15 12:32:29Z kaori $
   3  *
   4  * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
   5  * Copyright (c) 2002-2011, 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         TARGET_MANAGER_H_
  32 # define        TARGET_MANAGER_H_
  33
  34 #include "bool.h"
  35 #include "index_manager.h"
  36
  37 //! maximum length of target identifier
  38 #define MAX_LENOFTID 30
  39
  40 //! target parameters
  41 typedef struct target_param{
  42   char tid[MAX_LENOFTID];         //!< taregt identifier
  43   char *targetname;               //!< local file path or URL
  44   int fd;                         //!< file descriptor
  45   char *tmpfname;                 //!< temporal file name to download a remote target file
  46   int csn;                        //!< codestream number
  47   index_param_t *codeidx;         //!< index information of codestream
  48   int num_of_use;                 //!< numbers of sessions refering to this target
  49   bool jppstream;                 //!< if this target can return JPP-stream
  50   bool jptstream;                 //!< if this target can return JPP-stream
  51   struct target_param *next;      //!< pointer to the next target
  52 } target_param_t;
  53
  54
  55 //! Target list parameters
  56 typedef struct targetlist_param{
  57   target_param_t *first; //!< first target pointer of the list
  58   target_param_t *last;  //!< last  target pointer of the list
  59 } targetlist_param_t;
  60
  61
  62
  63 /**
  64  * generate a target list
  65  *
  66  * @return pointer to the generated target list
  67  */
  68 targetlist_param_t * gene_targetlist();
  69
  70
  71 /**
  72  * generate a target
  73  *
  74  * @param[in] targetlist target list to insert the generated target
  75  * @param[in] targetpath file path or URL of the target
  76  * @return               pointer to the generated target
  77  */
  78 target_param_t * gene_target( targetlist_param_t *targetlist, char *targetpath);
  79
  80
  81 /**
  82  * refer a target, used to make a new cache model
  83  *
  84  * @param[in]  reftarget reference target pointer
  85  * @param[out] ptr       address of feeding target pointer
  86  */
  87 void refer_target( target_param_t *reftarget, target_param_t **ptr);
  88
  89
  90 /**
  91  * refer a target, used to make a new cache model
  92  *
  93  * @param[in]  target reference pointer to the target
  94  */
  95 void unrefer_target( target_param_t *target);
  96
  97 /**
  98  * delete a target
  99  *
 100  * @param[in,out] target address of the deleting target pointer
 101  */
 102 void delete_target( target_param_t **target);
 103
 104
 105 /**
 106  * delete a target in list
 107  *
 108  * @param[in,out] target     address of the deleting target pointer
 109  * @param[in] targetlist target list pointer
 110  */
 111 void delete_target_in_list( target_param_t **target, targetlist_param_t *targetlist);
 112
 113
 114 /**
 115  * delete target list
 116  *
 117  * @param[in,out] targetlist address of the target list pointer
 118  */
 119 void delete_targetlist(targetlist_param_t **targetlist);
 120
 121
 122 /**
 123  * print target parameters
 124  *
 125  * @param[in] target target pointer
 126  */
 127 void print_target( target_param_t *target);
 128
 129 /**
 130  * print all target parameters
 131  *
 132  * @param[in] targetlist target list pointer
 133  */
 134 void print_alltarget( targetlist_param_t *targetlist);
 135
 136
 137 /**
 138  * search a target by target name
 139  *
 140  * @param[in] targetname target name
 141  * @param[in] targetlist target list pointer
 142  * @return               found target pointer
 143  */
 144 target_param_t * search_target( char targetname[], targetlist_param_t *targetlist);
 145
 146
 147 /**
 148  * search a target by tid
 149  *
 150  * @param[in] tid        target identifier
 151  * @param[in] targetlist target list pointer
 152  * @return               found target pointer
 153  */
 154 target_param_t * search_targetBytid( char tid[], targetlist_param_t *targetlist);
 155
 156 #endif      /* !TARGET_MANAGER_H_ */
 157