embedaddon/miniupnpc/man3/miniupnpc.3 - diff

Return to miniupnpc.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / miniupnpc / man3

Diff for /embedaddon/miniupnpc/man3/miniupnpc.3 between versions 1.1 and 1.1.1.2

version 1.1, 2012/02/21 23:16:22	version 1.1.1.2, 2023/09/27 11:21:37
Line 1	Line 1
\" $Id$	.TH MINIUPNPC 3
.TH miniupnpc 3
.SH NAME	.SH NAME
miniupnpc \- UPnP client library	miniupnpc \- UPnP client library
.SH SYNOPSIS	.SH SYNOPSIS
Line 26 through the miniupnpc API. The name of the C functions	Line 25 through the miniupnpc API. The name of the C functions
the UPnP methods names. ie: GetGenericPortMappingEntry is	the UPnP methods names. ie: GetGenericPortMappingEntry is
UPNP_GetGenericPortMappingEntry.	UPNP_GetGenericPortMappingEntry.
.SH "API FUNCTIONS"	.SH "API FUNCTIONS"
.IP "struct UPNPDev * upnpDiscover(int delay, const char * multicastif, const char * minissdpdsock, int sameport, int ipv6, int * error);"	.IP "struct UPNPDev * upnpDiscover(int delay, const char * multicastif, const char * minissdpdsock, int localport, int ipv6, int * error);"
execute the discovery process.	execute the discovery process.
delay (in millisecond) is the maximum time for waiting any device response.	delay (in millisecond) is the maximum time for waiting any device response.
If available, device list will be obtained from MiniSSDPd.	If available, device list will be obtained from MiniSSDPd.
Default path for minissdpd socket will be used if minissdpdsock argument is NULL.	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 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.	If localport is set to UPNP_LOCAL_PORT_SAME(1) SSDP packets will be sent
	from the source port 1900 (same as destination port), if set to
	UPNP_LOCAL_PORT_ANY(0) system assign a source port, any other value will
	be attempted as the source port.
If ipv6 is not 0, IPv6 is used instead of IPv4 for the discovery process.	If ipv6 is not 0, IPv6 is used instead of IPv4 for the discovery process.
.IP "void freeUPNPDevlist(struct UPNPDev * devlist);"	.IP "void freeUPNPDevlist(struct UPNPDev * devlist);"
free the list returned by upnpDiscover().	free the list returned by upnpDiscover().
.IP "int UPNP_GetValidIGD(struct UPNPDev * devlist, struct UPNPUrls * urls, struct IGDdatas * data, char * lanaddr, int lanaddrlen);"	.IP "int UPNP_GetValidIGD(struct UPNPDev * devlist, struct UPNPUrls * urls, struct IGDdatas * data, char * lanaddr, int lanaddrlen);"
browse the list of device returned by upnpDiscover(), find	browse the list of device returned by upnpDiscover(), find
a live UPnP internet gateway device and fill structures passed as arguments	a live UPnP internet gateway device and fill structures passed as arguments
with data used for UPNP methods invokation.	with data used for UPNP methods invocation.
.IP "int UPNP_GetIGDFromUrl(const char * rootdescurl, struct UPNPUrls * urls, struct IGDdatas * data, char * lanaddr, int lanaddrlen);"	.IP "int UPNP_GetIGDFromUrl(const char * rootdescurl, struct UPNPUrls * urls, struct IGDdatas * data, char * lanaddr, int lanaddrlen);"
permit to bypass the upnpDiscover() call if the xml root description	permit one to bypass the upnpDiscover() call if the xml root description
URL of the UPnP IGD is known.	URL of the UPnP IGD is known.
Fill structures passed as arguments	Fill structures passed as arguments
with data used for UPNP methods invokation.	with data used for UPNP methods invocation.
.IP "void GetUPNPUrls(struct UPNPUrls , struct IGDdatas , const char *);"	.IP "void GetUPNPUrls(struct UPNPUrls , struct IGDdatas , const char *);"
.IP "void FreeUPNPUrls(struct UPNPUrls *);"	.IP "void FreeUPNPUrls(struct UPNPUrls *);"

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1
changed lines
	Added in v.1.1.1.2