miniupnpc.h File Reference

#include "miniupnpc_declspec.h"
#include "igd_desc_parse.h"
#include "upnpdev.h"

Include dependency graph for miniupnpc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	UPNParg
struct	UPNPUrls

Macros
#define	UPNPDISCOVER_SUCCESS   (0)
#define	UPNPDISCOVER_UNKNOWN_ERROR   (-1)
#define	UPNPDISCOVER_SOCKET_ERROR   (-101)
#define	UPNPDISCOVER_MEMORY_ERROR   (-102)
#define	MINIUPNPC_VERSION   "2.2.1"
#define	MINIUPNPC_API_VERSION   17
#define	UPNP_LOCAL_PORT_ANY   0
#define	UPNP_LOCAL_PORT_SAME   1

Functions
char *	simpleUPnPcommand (int, const char *, const char *, const char *, struct UPNParg *, int *)
MINIUPNP_LIBSPEC struct UPNPDev *	upnpDiscover (int delay, const char *multicastif, const char *minissdpdsock, int localport, int ipv6, unsigned char ttl, int *error)
MINIUPNP_LIBSPEC struct UPNPDev *	upnpDiscoverAll (int delay, const char *multicastif, const char *minissdpdsock, int localport, int ipv6, unsigned char ttl, int *error)
MINIUPNP_LIBSPEC struct UPNPDev *	upnpDiscoverDevice (const char *device, int delay, const char *multicastif, const char *minissdpdsock, int localport, int ipv6, unsigned char ttl, int *error)
MINIUPNP_LIBSPEC struct UPNPDev *	upnpDiscoverDevices (const char *const deviceTypes[], int delay, const char *multicastif, const char *minissdpdsock, int localport, int ipv6, unsigned char ttl, int *error, int searchalltypes)
MINIUPNP_LIBSPEC void	parserootdesc (const char *, int, struct IGDdatas *)
MINIUPNP_LIBSPEC int	UPNP_GetValidIGD (struct UPNPDev *devlist, struct UPNPUrls *urls, struct IGDdatas *data, char *lanaddr, int lanaddrlen)
MINIUPNP_LIBSPEC int	UPNP_GetIGDFromUrl (const char *rootdescurl, struct UPNPUrls *urls, struct IGDdatas *data, char *lanaddr, int lanaddrlen)
MINIUPNP_LIBSPEC void	GetUPNPUrls (struct UPNPUrls *, struct IGDdatas *, const char *, unsigned int)
MINIUPNP_LIBSPEC void	FreeUPNPUrls (struct UPNPUrls *)
MINIUPNP_LIBSPEC int	UPNPIGD_IsConnected (struct UPNPUrls *, struct IGDdatas *)

Macro Definition Documentation

MINIUPNPC_API_VERSION

#define MINIUPNPC_API_VERSION   17

MINIUPNPC_VERSION

#define MINIUPNPC_VERSION   "2.2.1"

UPNP_LOCAL_PORT_ANY

#define UPNP_LOCAL_PORT_ANY   0

UPNP_LOCAL_PORT_SAME

#define UPNP_LOCAL_PORT_SAME   1

UPNPDISCOVER_MEMORY_ERROR

#define UPNPDISCOVER_MEMORY_ERROR   (-102)

UPNPDISCOVER_SOCKET_ERROR

#define UPNPDISCOVER_SOCKET_ERROR   (-101)

UPNPDISCOVER_SUCCESS

#define UPNPDISCOVER_SUCCESS   (0)

UPNPDISCOVER_UNKNOWN_ERROR

#define UPNPDISCOVER_UNKNOWN_ERROR   (-1)

Function Documentation

FreeUPNPUrls()

MINIUPNP_LIBSPEC void FreeUPNPUrls

(

struct UPNPUrls *

urls

)

GetUPNPUrls()

MINIUPNP_LIBSPEC void GetUPNPUrls	(	struct UPNPUrls *	urls,
		struct IGDdatas *	data,
		const char *	descURL,
		unsigned int	scope_id )

parserootdesc()

MINIUPNP_LIBSPEC void parserootdesc	(	const char *	buffer,
		int	bufsize,
		struct IGDdatas *	data )

simpleUPnPcommand()

char * simpleUPnPcommand	(	int	s,
		const char *	url,
		const char *	service,
		const char *	action,
		struct UPNParg *	args,
		int *	bufsize )

UPNP_GetIGDFromUrl()

MINIUPNP_LIBSPEC int UPNP_GetIGDFromUrl	(	const char *	rootdescurl,
		struct UPNPUrls *	urls,
		struct IGDdatas *	data,
		char *	lanaddr,
		int	lanaddrlen )

UPNP_GetValidIGD()

MINIUPNP_LIBSPEC int UPNP_GetValidIGD	(	struct UPNPDev *	devlist,
		struct UPNPUrls *	urls,
		struct IGDdatas *	data,
		char *	lanaddr,
		int	lanaddrlen )

upnpDiscover()

MINIUPNP_LIBSPEC struct UPNPDev * upnpDiscover	(	int	delay,
		const char *	multicastif,
		const char *	minissdpdsock,
		int	localport,
		int	ipv6,
		unsigned char	ttl,
		int *	error )

upnpDiscoverAll()

MINIUPNP_LIBSPEC struct UPNPDev * upnpDiscoverAll	(	int	delay,
		const char *	multicastif,
		const char *	minissdpdsock,
		int	localport,
		int	ipv6,
		unsigned char	ttl,
		int *	error )

upnpDiscoverDevice()

MINIUPNP_LIBSPEC struct UPNPDev * upnpDiscoverDevice	(	const char *	device,
		int	delay,
		const char *	multicastif,
		const char *	minissdpdsock,
		int	localport,
		int	ipv6,
		unsigned char	ttl,
		int *	error )

upnpDiscoverDevices()

MINIUPNP_LIBSPEC struct UPNPDev * upnpDiscoverDevices	(	const char *const	deviceTypes[],
		int	delay,
		const char *	multicastif,
		const char *	minissdpdsock,
		int	localport,
		int	ipv6,
		unsigned char	ttl,
		int *	error,
		int	searchalltypes )

UPNPIGD_IsConnected()

MINIUPNP_LIBSPEC int UPNPIGD_IsConnected	(	struct UPNPUrls *	urls,
		struct IGDdatas *	data )