gst/rtsp-server/rtsp-address-pool.h

   1 /* GStreamer
   2  * Copyright (C) 2012 Wim Taymans <wim.taymans at gmail.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #include <gst/gst.h>
  21
  22 #ifndef __GST_RTSP_ADDRESS_POOL_H__
  23 #define __GST_RTSP_ADDRESS_POOL_H__
  24
  25 G_BEGIN_DECLS
  26
  27 #define GST_TYPE_RTSP_ADDRESS_POOL              (gst_rtsp_address_pool_get_type ())
  28 #define GST_IS_RTSP_ADDRESS_POOL(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_ADDRESS_POOL))
  29 #define GST_IS_RTSP_ADDRESS_POOL_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_ADDRESS_POOL))
  30 #define GST_RTSP_ADDRESS_POOL_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_ADDRESS_POOL, GstRTSPAddressPoolClass))
  31 #define GST_RTSP_ADDRESS_POOL(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_ADDRESS_POOL, GstRTSPAddressPool))
  32 #define GST_RTSP_ADDRESS_POOL_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_ADDRESS_POOL, GstRTSPAddressPoolClass))
  33 #define GST_RTSP_ADDRESS_POOL_CAST(obj)         ((GstRTSPAddressPool*)(obj))
  34 #define GST_RTSP_ADDRESS_POOL_CLASS_CAST(klass) ((GstRTSPAddressPoolClass*)(klass))
  35
  36 typedef struct _GstRTSPAddress GstRTSPAddress;
  37 typedef struct _GstRTSPAddressClass GstRTSPAddressClass;
  38
  39 typedef struct _GstRTSPAddressPool GstRTSPAddressPool;
  40 typedef struct _GstRTSPAddressPoolClass GstRTSPAddressPoolClass;
  41 typedef struct _GstRTSPAddressPoolPrivate GstRTSPAddressPoolPrivate;
  42
  43 struct _GstRTSPAddress {
  44   GstRTSPAddressPool *pool;
  45
  46   gchar *address;
  47   guint16 port;
  48   gint n_ports;
  49   guint8 ttl;
  50
  51   gpointer priv;
  52 };
  53
  54 GType gst_rtsp_address_get_type        (void);
  55
  56 GstRTSPAddress * gst_rtsp_address_copy (GstRTSPAddress *addr);
  57 void             gst_rtsp_address_free (GstRTSPAddress *addr);
  58
  59 typedef enum {
  60   GST_RTSP_ADDRESS_FLAG_NONE      = 0,
  61   GST_RTSP_ADDRESS_FLAG_IPV4      = (1 << 0),
  62   GST_RTSP_ADDRESS_FLAG_IPV6      = (1 << 1),
  63   GST_RTSP_ADDRESS_FLAG_EVEN_PORT = (1 << 2),
  64   GST_RTSP_ADDRESS_FLAG_MULTICAST = (1 << 3),
  65   GST_RTSP_ADDRESS_FLAG_UNICAST   = (1 << 4),
  66 } GstRTSPAddressFlags;
  67
  68 /**
  69  * GST_RTSP_ADDRESS_POOL_ANY_IPV4:
  70  *
  71  * Used with gst_rtsp_address_pool_add_range_unicast() to bind to all
  72  * IPv4 addresses
  73  */
  74
  75 /**
  76  * GST_RTSP_ADDRESS_POOL_ANY_IPV6:
  77  *
  78  * Used with gst_rtsp_address_pool_add_range_unicast() to bind to all
  79  * IPv6 addresses
  80  */
  81
  82 #define GST_RTSP_ADDRESS_POOL_ANY_IPV4  "0.0.0.0"
  83 #define GST_RTSP_ADDRESS_POOL_ANY_IPV6  "::"
  84
  85 /**
  86  * GstRTSPAddressPool:
  87  * @parent: the parent GObject
  88  *
  89  * An address pool, all member are prive
  90  */
  91 struct _GstRTSPAddressPool {
  92   GObject       parent;
  93
  94   GstRTSPAddressPoolPrivate *priv;
  95 };
  96
  97 struct _GstRTSPAddressPoolClass {
  98   GObjectClass  parent_class;
  99 };
 100
 101 GType                  gst_rtsp_address_pool_get_type        (void);
 102
 103 /* create a new address pool */
 104 GstRTSPAddressPool *   gst_rtsp_address_pool_new             (void);
 105
 106 void                   gst_rtsp_address_pool_clear           (GstRTSPAddressPool * pool);
 107 void                   gst_rtsp_address_pool_dump            (GstRTSPAddressPool * pool);
 108
 109 gboolean               gst_rtsp_address_pool_add_range       (GstRTSPAddressPool * pool,
 110                                                               const gchar *min_address,
 111                                                               const gchar *max_address,
 112                                                               guint16 min_port,
 113                                                               guint16 max_port,
 114                                                               guint8 ttl);
 115
 116 gboolean               gst_rtsp_address_pool_add_range_unicast (GstRTSPAddressPool * pool,
 117                                                               const gchar *min_address,
 118                                                               const gchar *max_address,
 119                                                               guint16 min_port,
 120                                                               guint16 max_port);
 121
 122 GstRTSPAddress *       gst_rtsp_address_pool_acquire_address (GstRTSPAddressPool * pool,
 123                                                               GstRTSPAddressFlags flags,
 124                                                               gint n_ports);
 125
 126 GstRTSPAddress *       gst_rtsp_address_pool_reserve_address (GstRTSPAddressPool * pool,
 127                                                               const gchar *address,
 128                                                               guint port,
 129                                                               guint n_ports,
 130                                                               guint ttl);
 131
 132 gboolean               gst_rtsp_address_pool_has_unicast_addresses (GstRTSPAddressPool * pool);
 133
 134 G_END_DECLS
 135
 136 #endif /* __GST_RTSP_ADDRESS_POOL_H__ */