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
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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.
31 #ifndef TARGET_MANAGER_H_
32 # define TARGET_MANAGER_H_
34 #include "index_manager.h"
36 /** maximum length of target identifier*/
37 #define MAX_LENOFTID 30
39 /** target parameters*/
40 typedef struct target_param{
41 char tid[MAX_LENOFTID]; /**< target identifier*/
42 char *targetname; /**< local file path or URL ( URL is suported only with SERVER mode)*/
43 int fd; /**< file descriptor*/
45 char *tmpfname; /**< temporal file name to download a remote target file*/
47 int csn; /**< codestream number */
48 index_param_t *codeidx; /**< index information of codestream */
49 int num_of_use; /**< numbers of sessions refering to this target */
50 OPJ_BOOL jppstream; /**< if this target can return JPP-stream */
51 OPJ_BOOL jptstream; /**< if this target can return JPP-stream */
52 struct target_param *next; /**< pointer to the next target */
56 /** Target list parameters*/
57 typedef struct targetlist_param{
58 target_param_t *first; /**< first target pointer of the list*/
59 target_param_t *last; /**< last target pointer of the list*/
65 * generate a target list
67 * @return pointer to the generated target list
69 targetlist_param_t * gene_targetlist(void);
75 * @param[in] targetlist target list to insert the generated target
76 * @param[in] targetpath file path or URL of the target
77 * @return pointer to the generated target
79 target_param_t * gene_target( targetlist_param_t *targetlist, char *targetpath);
83 * refer a target, used to make a new cache model
85 * @param[in] reftarget reference target pointer
86 * @param[out] ptr address of feeding target pointer
88 void refer_target( target_param_t *reftarget, target_param_t **ptr);
92 * refer a target, used to make a new cache model
94 * @param[in] target reference pointer to the target
96 void unrefer_target( target_param_t *target);
101 * @param[in,out] target address of the deleting target pointer
103 void delete_target( target_param_t **target);
107 * delete a target in list
109 * @param[in,out] target address of the deleting target pointer
110 * @param[in] targetlist target list pointer
112 void delete_target_in_list( target_param_t **target, targetlist_param_t *targetlist);
118 * @param[in,out] targetlist address of the target list pointer
120 void delete_targetlist(targetlist_param_t **targetlist);
124 * print target parameters
126 * @param[in] target target pointer
128 void print_target( target_param_t *target);
131 * print all target parameters
133 * @param[in] targetlist target list pointer
135 void print_alltarget( targetlist_param_t *targetlist);
139 * search a target by target name
141 * @param[in] targetname target name
142 * @param[in] targetlist target list pointer
143 * @return found target pointer
145 target_param_t * search_target( const char targetname[], targetlist_param_t *targetlist);
149 * search a target by tid
151 * @param[in] tid target identifier
152 * @param[in] targetlist target list pointer
153 * @return found target pointer
155 target_param_t * search_targetBytid( const char tid[], targetlist_param_t *targetlist);
157 #endif /* !TARGET_MANAGER_H_ */