Merge pull request #703 from ioxp/fix/mg_server_ports

WIP: Fixed typo mg_server_ports -> mg_server_port

docs/APIReference.md

@@ -39,7 +39,7 @@ The content of both structures is not defined in the interface - they are only u
 * [`struct mg_option;`](api/mg_option.md)
 * [`struct mg_request_info;`](api/mg_request_info.md)
 * [`struct mg_response_info;`](api/mg_response_info.md)
-* [`struct mg_server_ports;`](api/mg_server_ports.md)
+* [`struct mg_server_port;`](api/mg_server_port.md)
 
 
 ## Library API Functions

docs/api/mg_get_ports.md

@@ -27,5 +27,5 @@ The function returns the number of ports actually stored in the buffer.
 
 ### See Also
 
-* [`struct mg_server_ports;`](mg_server_ports.md)
+* [`struct mg_server_port;`](mg_server_port.md)
 * [`mg_get_server_ports();`](mg_get_server_ports.md)

docs/api/mg_get_server_ports.md

@@ -8,7 +8,7 @@
 | :--- | :--- | :--- |
 |**`ctx`**|`const struct mg_context *`|The context for which the server ports are requested|
 |**`size`**|`int`|The size of the buffer to store the port information|
-|**`ports`**|`struct mg_server_ports *`|Buffer to store the port information|
+|**`ports`**|`struct mg_server_port *`|Buffer to store the port information|
 
 ### Return Value
 
@@ -25,4 +25,4 @@ The function returns the number of items in the list, or a negative value if an
 ### See Also
 
 * [~~`mg_get_ports();`~~](mg_get_ports.md)
-* [`struct mg_server_ports;`](mg_server_ports.md)
+* [`struct mg_server_port;`](mg_server_port.md)

docs/api/mg_server_ports.md → docs/api/mg_server_port.md

@@ -1,6 +1,6 @@
 # Civetweb API Reference
 
-### `struct mg_server_ports;`
+### `struct mg_server_port;`
 
 ### Fields
 
@@ -17,7 +17,7 @@
 
 ### Description
 
-A call to the function [`mg_get_server_ports()`](mg_get_server_ports.md) returns a list of structures with information about each running Civetweb service. These structures are of type `struct mg_server_ports` and contain the base information of each service.
+A call to the function [`mg_get_server_ports()`](mg_get_server_ports.md) returns a list of structures with information about each running Civetweb service. These structures are of type `struct mg_server_port` and contain the base information of each service.
 
 ### See Also
 

examples/embedded_c/embedded_c.c

@@ -960,7 +960,7 @@ main(int argc, char *argv[])
 	    0};
 	struct mg_callbacks callbacks;
 	struct mg_context *ctx;
-	struct mg_server_ports ports[32];
+	struct mg_server_port ports[32];
 	int port_cnt, n;
 	int err = 0;
 

include/CivetServer.h

@@ -376,7 +376,7 @@ class CIVETWEB_CXX_API CivetServer
 	 *
 	 * @return A vector of ports
 	 */
-	std::vector<struct mg_server_ports> getListeningPortsFull();
+	std::vector<struct mg_server_port> getListeningPortsFull();
 
 	/**
 	 * getCookie(struct mg_connection *conn, const std::string &cookieName,

include/civetweb.h

@@ -681,7 +681,7 @@ enum {
 CIVETWEB_API const struct mg_option *mg_get_valid_options(void);
 
 
-struct mg_server_ports {
+struct mg_server_port {
 	int protocol;    /* 1 = IPv4, 2 = IPv6, 3 = both */
 	int port;        /* port number */
 	int is_ssl;      /* https port: 0 = no, 1 = yes */
@@ -692,15 +692,18 @@ struct mg_server_ports {
 	int _reserved4;
 };
 
+// Legacy name
+#define mg_server_ports mg_server_port
+
 
 /* Get the list of ports that civetweb is listening on.
    The parameter size is the size of the ports array in elements.
    The caller is responsibility to allocate the required memory.
-   This function returns the number of struct mg_server_ports elements
+   This function returns the number of struct mg_server_port elements
    filled in, or <0 in case of an error. */
 CIVETWEB_API int mg_get_server_ports(const struct mg_context *ctx,
                                      int size,
-                                     struct mg_server_ports *ports);
+                                     struct mg_server_port *ports);
 
 
 #if defined(MG_LEGACY_INTERFACE) /* 2017-04-02 */

src/CivetServer.cpp

@@ -621,7 +621,7 @@ CivetServer::urlEncode(const char *src,
 std::vector<int>
 CivetServer::getListeningPorts()
 {
-	std::vector<struct mg_server_ports> server_ports = getListeningPortsFull();
+	std::vector<struct mg_server_port> server_ports = getListeningPortsFull();
 
 	std::vector<int> ports(server_ports.size());
 	for (size_t i = 0; i < server_ports.size(); i++) {
@@ -631,10 +631,10 @@ CivetServer::getListeningPorts()
 	return ports;
 }
 
-std::vector<struct mg_server_ports>
+std::vector<struct mg_server_port>
 CivetServer::getListeningPortsFull()
 {
-	std::vector<struct mg_server_ports> server_ports(50);
+	std::vector<struct mg_server_port> server_ports(50);
 	int size = mg_get_server_ports(context,
 	                               (int)server_ports.size(),
 	                               &server_ports[0]);

src/civetweb.c

@@ -3504,7 +3504,7 @@ mg_get_ports(const struct mg_context *ctx, size_t size, int *ports, int *ssl)
 int
 mg_get_server_ports(const struct mg_context *ctx,
                     int size,
-                    struct mg_server_ports *ports)
+                    struct mg_server_port *ports)
 {
 	int i, cnt = 0;
 

unittest/public_server.c

@@ -344,7 +344,7 @@ test_mg_start_stop_http_server_impl(int ipv6, int bound)
 	char client_err[256];
 	const struct mg_response_info *client_ri;
 	int client_res, ret;
-	struct mg_server_ports portinfo[8];
+	struct mg_server_port portinfo[8];
 
 	mark_point();
 
@@ -585,7 +585,7 @@ START_TEST(test_mg_start_stop_https_server)
 	char client_err[256];
 	const struct mg_response_info *client_ri;
 	int client_res, ret;
-	struct mg_server_ports portinfo[8];
+	struct mg_server_port portinfo[8];
 
 	ck_assert(ssl_cert != NULL);
 
@@ -699,7 +699,7 @@ START_TEST(test_mg_server_and_client_tls)
 	struct mg_context *ctx;
 
 	int ports_cnt;
-	struct mg_server_ports ports[16];
+	struct mg_server_port ports[16];
 	struct mg_callbacks callbacks;
 	char errmsg[256];