source: trunk/third-party/miniupnp/upnpcommands.h @ 6848

Last change on this file since 6848 was 6848, checked in by charles, 13 years ago

updated to miniupnpc-20081002

File size: 6.2 KB
Line 
1/* $Id: upnpcommands.h,v 1.14 2008/09/25 18:02:50 nanard Exp $ */
2/* Miniupnp project : http://miniupnp.free.fr/
3 * Author : Thomas Bernard
4 * Copyright (c) 2005-2008 Thomas Bernard
5 * This software is subject to the conditions detailed in the
6 * LICENCE file provided within this distribution */
7#ifndef __UPNPCOMMANDS_H__
8#define __UPNPCOMMANDS_H__
9
10#include "upnpreplyparse.h"
11#include "declspec.h"
12
13/* MiniUPnPc return codes : */
14#define UPNPCOMMAND_SUCCESS (0)
15#define UPNPCOMMAND_UNKNOWN_ERROR (-1)
16#define UPNPCOMMAND_INVALID_ARGS (-2)
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
22LIBSPEC unsigned int
23UPNP_GetTotalBytesSent(const char * controlURL,
24                                        const char * servicetype);
25
26LIBSPEC unsigned int
27UPNP_GetTotalBytesReceived(const char * controlURL,
28                                                const char * servicetype);
29
30LIBSPEC unsigned int
31UPNP_GetTotalPacketsSent(const char * controlURL,
32                                        const char * servicetype);
33
34LIBSPEC unsigned int
35UPNP_GetTotalPacketsReceived(const char * controlURL,
36                                        const char * servicetype);
37
38/* UPNP_GetStatusInfo()
39 * status and lastconnerror are 64 byte buffers
40 * Return values :
41 * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR
42 * or a UPnP Error code */
43LIBSPEC int
44UPNP_GetStatusInfo(const char * controlURL,
45                               const char * servicetype,
46                                   char * status,
47                                   unsigned int * uptime,
48                   char * lastconnerror);
49
50/* UPNP_GetConnectionTypeInfo()
51 * argument connectionType is a 64 character buffer
52 * Return Values :
53 * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR
54 * or a UPnP Error code */
55LIBSPEC int
56UPNP_GetConnectionTypeInfo(const char * controlURL,
57                           const char * servicetype,
58                                                   char * connectionType);
59
60/* UPNP_GetExternalIPAddress() call the corresponding UPNP method.
61 * if the third arg is not null the value is copied to it.
62 * at least 16 bytes must be available
63 *
64 * Return values :
65 * 0 : SUCCESS
66 * NON ZERO : ERROR Either an UPnP error code or an unknown error.
67 *
68 * possible UPnP Errors :
69 * 402 Invalid Args - See UPnP Device Architecture section on Control.
70 * 501 Action Failed - See UPnP Device Architecture section on Control. */
71LIBSPEC int
72UPNP_GetExternalIPAddress(const char * controlURL,
73                          const char * servicetype,
74                          char * extIpAdd);
75
76/* UPNP_GetLinkLayerMaxBitRates()
77 * call WANCommonInterfaceConfig:1#GetCommonLinkProperties
78 *
79 * return values :
80 * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR
81 * or a UPnP Error Code. */
82LIBSPEC int
83UPNP_GetLinkLayerMaxBitRates(const char* controlURL,
84                                                        const char* servicetype,
85                                                        unsigned int * bitrateDown,
86                                                        unsigned int * bitrateUp);
87
88/* UPNP_AddPortMapping()
89 *
90 * Return values :
91 * 0 : SUCCESS
92 * NON ZERO : ERROR. Either an UPnP error code or an unknown error.
93 *
94 * List of possible UPnP errors for AddPortMapping :
95 * errorCode errorDescription (short) - Description (long)
96 * 402 Invalid Args - See UPnP Device Architecture section on Control.
97 * 501 Action Failed - See UPnP Device Architecture section on Control.
98 * 715 WildCardNotPermittedInSrcIP - The source IP address cannot be
99 *                                   wild-carded
100 * 716 WildCardNotPermittedInExtPort - The external port cannot be wild-carded
101 * 718 ConflictInMappingEntry - The port mapping entry specified conflicts
102 *                     with a mapping assigned previously to another client
103 * 724 SamePortValuesRequired - Internal and External port values
104 *                              must be the same
105 * 725 OnlyPermanentLeasesSupported - The NAT implementation only supports
106 *                  permanent lease times on port mappings
107 * 726 RemoteHostOnlySupportsWildcard - RemoteHost must be a wildcard
108 *                             and cannot be a specific IP address or DNS name
109 * 727 ExternalPortOnlySupportsWildcard - ExternalPort must be a wildcard and
110 *                                        cannot be a specific port value */
111LIBSPEC int
112UPNP_AddPortMapping(const char * controlURL, const char * servicetype,
113                    const char * extPort,
114                                    const char * inPort,
115                                        const char * inClient,
116                                        const char * desc,
117                    const char * proto);
118
119/* UPNP_DeletePortMapping()
120 * Return Values :
121 * 0 : SUCCESS
122 * NON ZERO : error. Either an UPnP error code or an undefined error.
123 *
124 * List of possible UPnP errors for DeletePortMapping :
125 * 402 Invalid Args - See UPnP Device Architecture section on Control.
126 * 714 NoSuchEntryInArray - The specified value does not exist in the array */
127LIBSPEC int
128UPNP_DeletePortMapping(const char * controlURL, const char * servicetype,
129                       const char * extPort, const char * proto);
130
131/* UPNP_GetPortMappingNumberOfEntries()
132 * not supported by all routers */
133LIBSPEC int
134UPNP_GetPortMappingNumberOfEntries(const char* controlURL, const char* servicetype, unsigned int * num);
135
136/* UPNP_GetSpecificPortMappingEntry retrieves an existing port mapping
137 * the result is returned in the intClient and intPort strings
138 * please provide 16 and 6 bytes of data
139 *
140 * return value :
141 * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR
142 * or a UPnP Error Code. */
143LIBSPEC int
144UPNP_GetSpecificPortMappingEntry(const char * controlURL,
145                                 const char * servicetype,
146                                 const char * extPort,
147                                 const char * proto,
148                                 char * intClient,
149                                 char * intPort);
150
151/* UPNP_GetGenericPortMappingEntry()
152 *
153 * return value :
154 * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR
155 * or a UPnP Error Code.
156 *
157 * Possible UPNP Error codes :
158 * 402 Invalid Args - See UPnP Device Architecture section on Control.
159 * 713 SpecifiedArrayIndexInvalid - The specified array index is out of bounds
160 */
161LIBSPEC int
162UPNP_GetGenericPortMappingEntry(const char * controlURL,
163                                const char * servicetype,
164                                                                const char * index,
165                                                                char * extPort,
166                                                                char * intClient,
167                                                                char * intPort,
168                                                                char * protocol,
169                                                                char * desc,
170                                                                char * enabled,
171                                                                char * rHost,
172                                                                char * duration);
173
174#ifdef __cplusplus
175}
176#endif
177
178#endif
179
Note: See TracBrowser for help on using the repository browser.