src/lib/openjpip/auxtrans_manager.h

   1 /*
   2  * $Id$
   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         AUXTRANS_MANAGER_H_
  32 # define        AUXTRANS_MANAGER_H_
  33
  34 #include "sock_manager.h"
  35 #include "opj_includes.h"
  36
  37 /** auxiliary transport setting parameters*/
  38 typedef struct auxtrans_param{
  39   int tcpauxport;       /**< tcp port*/
  40   int udpauxport;       /**< udp port*/
  41   SOCKET tcplistensock; /**< listenning socket for aux tcp (-1 if not open)*/
  42   SOCKET udplistensock; /**< listenning socket for aux udp (-1 if not open)*/
  43 } auxtrans_param_t;
  44
  45 /**
  46  * Initialize auxiliary transport server of JPIP server
  47  *
  48  * @param[in] tcp_auxport opening tcp auxiliary port ( 0 not to open, valid No. 49152-65535)
  49  * @param[in] udp_auxport opening udp auxiliary port ( 0 not to open, valid No. 49152-65535)
  50  * @return                intialized transport parameters
  51  */
  52 auxtrans_param_t init_aux_transport( int tcp_auxport, int udp_auxport);
  53
  54 /**
  55  * Close auxiliary transport server of JPIP server
  56  *
  57  * @param[in] auxtrans closing transport server
  58  */
  59 void close_aux_transport( auxtrans_param_t auxtrans);
  60
  61 /**
  62  * Send response data on aux transport
  63  *
  64  * @param[in] istcp          true if tcp, false if udp
  65  * @param[in] auxtrans       available transport parameters
  66  * @param[in] cid            channel ID
  67  * @param[in] data           sending data
  68  * @param[in] length         length of data
  69  * @param[in] maxlenPerFrame maximum data length to send per frame
  70  */
  71 void send_responsedata_on_aux( opj_bool istcp, auxtrans_param_t auxtrans, const char cid[], void *data, OPJ_SIZE_T length, OPJ_SIZE_T maxlenPerFrame);
  72
  73 #endif /* !AUXTRANS_MANAGER_H_ */