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