/* $Id: miniupnpc.h,v 1.18 2008/09/25 18:02:50 nanard Exp $ */
/* Project: miniupnp
 * http://miniupnp.free.fr/
 * Author: Thomas Bernard
 * Copyright (c) 2005-2006 Thomas Bernard
 * This software is subjects to the conditions detailed
 * in the LICENCE file provided within this distribution */
#ifndef __MINIUPNPC_H__
#define __MINIUPNPC_H__

#include "declspec.h"
#include "igd_desc_parse.h"

#ifdef WIN32
#include <winsock2.h>
#else
#include <sys/socket.h>
#endif

#ifdef __cplusplus
extern "C"
{
#endif

/* Structures definitions : */
  struct UPNParg
  {
    const char *elt;
    const char *val;
  };

  int simpleUPnPcommand (int s, const char *, const char *,
                         const char *, struct UPNParg *, char *, int *);

  struct UPNPDev
  {
    struct UPNPDev *pNext;
    char *descURL;
    char *st;
    char buffer[2];
  };

/* upnpDiscover()
 * discover UPnP devices on the network.
 * The discovered devices are returned as a chained list.
 * It is up to the caller to free the list with freeUPNPDevlist().
 * delay (in millisecond) is the maximum time for waiting any device
 * response.
 * If available, device list will be obtained from MiniSSDPd.
 * Default path for minissdpd socket will be used if minissdpdsock argument
 * is NULL.
 * If multicastif is not NULL, it will be used instead of the default
 * multicast interface for sending SSDP discover packets.
 * If sameport is not null, SSDP packets will be sent from the source port
 * 1900 (same as destination port) otherwise system assign a source port. */
  LIBSPEC struct UPNPDev *upnpDiscover (int delay, const char *multicastif, const struct sockaddr *addr,
                                                     const char *minissdpdsock, int sameport);
/* freeUPNPDevlist()
 * free list returned by upnpDiscover() */
  LIBSPEC void freeUPNPDevlist (struct UPNPDev *devlist);

/* parserootdesc() :
 * parse root XML description of a UPnP device and fill the IGDdatas
 * structure. */
  LIBSPEC void parserootdesc (const char *, int, struct IGDdatas *);

/* structure used to get fast access to urls
 * controlURL: controlURL of the WANIPConnection
 * ipcondescURL: url of the description of the WANIPConnection
 * controlURL_CIF: controlURL of the WANCommonInterfaceConfig
 */
  struct UPNPUrls
  {
    char *controlURL;
    char *ipcondescURL;
    char *controlURL_CIF;
  };

/* UPNP_GetValidIGD() :
 * return values :
 *     0 = NO IGD found
 *     1 = A valid connected IGD has been found
 *     2 = A valid IGD has been found but it reported as
 *         not connected
 *     3 = an UPnP device has been found but was not recognized as an IGD
 *
 * In any non zero return case, the urls and data structures
 * passed as parameters are set. Donc forget to call FreeUPNPUrls(urls) to
 * free allocated memory.
 */
  LIBSPEC int
    UPNP_GetValidIGD (struct UPNPDev *devlist,
                      struct UPNPUrls *urls,
                      struct IGDdatas *data, char *lanaddr, int lanaddrlen);

/* UPNP_GetIGDFromUrl()
 * Used when skipping the discovery process.
 * return value :
 *   0 - Not ok
 *   1 - OK */
  LIBSPEC int
    UPNP_GetIGDFromUrl (const char *rootdescurl,
                        struct UPNPUrls *urls,
                        struct IGDdatas *data, char *lanaddr, int lanaddrlen);

  LIBSPEC void GetUPNPUrls (struct UPNPUrls *, struct IGDdatas *,
                            const char *);

  LIBSPEC void FreeUPNPUrls (struct UPNPUrls *);

/* Reads data from the specified socket. 
 * Returns the number of bytes read if successful, zero if no bytes were 
 * read or if we timed out. Returns negative if there was an error. */
  int ReceiveData (int socket, char *data, int length, int timeout);

#ifdef __cplusplus
}
#endif

#endif