libpurple/nat-pmp.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * Most code in nat-pmp.h copyright (C) 2007, R. Tyler Ballance, bleep, LLC.
   8  * This file is distributed under the 3-clause (modified) BSD license:
   9  * Redistribution and use in source and binary forms, with or without modification, are permitted
  10  * provided that the following conditions are met:
  11  *
  12  * Redistributions of source code must retain the above copyright notice, this list of conditions and
  13  * the following disclaimer.
  14  * Neither the name of the bleep. LLC nor the names of its contributors may be used to endorse or promote
  15  * products derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  19  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  23  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  24  * OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef PURPLE_NAT_PMP_H
  28 #define PURPLE_NAT_PMP_H
  29 /**
  30  * SECTION:nat-pmp
  31  * @section_id: libpurple-nat-pmp
  32  * @short_description: <filename>nat-pmp.h</filename>
  33  * @title: NAT-PMP Implementation
  34  */
  35
  36 #include <glib.h>
  37
  38 #define PURPLE_PMP_LIFETIME     3600    /* 3600 seconds */
  39
  40 typedef enum {
  41         PURPLE_PMP_TYPE_UDP,
  42         PURPLE_PMP_TYPE_TCP
  43 } PurplePmpType;
  44
  45 G_BEGIN_DECLS
  46
  47 /**
  48  * purple_pmp_init:
  49  *
  50  * Initialize nat-pmp
  51  */
  52 void purple_pmp_init(void);
  53
  54 char *purple_pmp_get_public_ip(void);
  55
  56 /**
  57  * purple_pmp_create_map:
  58  * @type:        The PurplePmpType
  59  * @privateport: The private port on which we are listening locally
  60  * @publicport:  The public port on which we are expecting a response
  61  * @lifetime:    The lifetime of the mapping. It is recommended that this
  62  *                    be PURPLE_PMP_LIFETIME.
  63  *
  64  * Remove the NAT-PMP mapping for a specified type on a specified port
  65  *
  66  * Returns: TRUE if successful; FALSE if unsuccessful
  67  */
  68 gboolean purple_pmp_create_map(PurplePmpType type, unsigned short privateport,
  69                                unsigned short publicport, int lifetime);
  70
  71 /**
  72  * purple_pmp_destroy_map:
  73  * @type:        The PurplePmpType
  74  * @privateport: The private port on which the mapping was previously made
  75  *
  76  * Remove the NAT-PMP mapping for a specified type on a specified port
  77  *
  78  * Returns: TRUE if successful; FALSE if unsuccessful
  79  */
  80 gboolean purple_pmp_destroy_map(PurplePmpType type, unsigned short privateport);
  81
  82 G_END_DECLS
  83
  84 #endif /* PURPLE_NAT_PMP_H */