luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-05-03 12:36:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typos in networking classes

Browse Source
This commit is contained in:
Thomas Hindoe Paaboel Andersen 2011-04-20 19:08:06 +02:00
parent c2f670ef49
commit f42d97b88b
7 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
gio/gsocketclient.c
View File

@ -58,7 +58,7 @@
* #GSocketClient is a high-level utility class for connecting to a * #GSocketClient is a high-level utility class for connecting to a
* network host using a connection oriented socket type. * network host using a connection oriented socket type.
* *
* You create a #GSocketClient object, set any options you want, then * You create a #GSocketClient object, set any options you want, and then
* call a sync or async connect operation, which returns a #GSocketConnection * call a sync or async connect operation, which returns a #GSocketConnection
* subclass on success. * subclass on success.
* *
@ -442,7 +442,7 @@ g_socket_client_get_local_address (GSocketClient *client)
* The sockets created by this object will bound to the * The sockets created by this object will bound to the
* specified address (if not %NULL) before connecting. * specified address (if not %NULL) before connecting.
* *
* This is useful if you want to ensure the the local * This is useful if you want to ensure that the local
* side of the connection is on a specific port, or on * side of the connection is on a specific port, or on
* a specific interface. * a specific interface.
* *
@ -726,7 +726,7 @@ g_socket_client_class_init (GSocketClientClass *class)
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: #GError for error reporting, or %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore.
* *
* Tries to resolve the @connectable and make a network connection to it.. * Tries to resolve the @connectable and make a network connection to it.
* *
* Upon a successful connection, a new #GSocketConnection is constructed * Upon a successful connection, a new #GSocketConnection is constructed
* and returned. The caller owns this new object and must drop their * and returned. The caller owns this new object and must drop their
@ -736,7 +736,7 @@ g_socket_client_class_init (GSocketClientClass *class)
* the underlying socket that is used. For instance, for a TCP/IP connection * the underlying socket that is used. For instance, for a TCP/IP connection
* it will be a #GTcpConnection. * it will be a #GTcpConnection.
* *
* The socket created will be the same family as the the address that the * The socket created will be the same family as the address that the
* @connectable resolves to, unless family is set with g_socket_client_set_family() * @connectable resolves to, unless family is set with g_socket_client_set_family()
* or indirectly via g_socket_client_set_local_address(). The socket type * or indirectly via g_socket_client_set_local_address(). The socket type
* defaults to %G_SOCKET_TYPE_STREAM but can be set with * defaults to %G_SOCKET_TYPE_STREAM but can be set with
@ -912,7 +912,7 @@ g_socket_client_connect (GSocketClient *client,
* *
* Attempts to create a TCP connection to the named host. * Attempts to create a TCP connection to the named host.
* *
* @host_and_port may be in any of a number of recognised formats; an IPv6 * @host_and_port may be in any of a number of recognized formats; an IPv6
* address, an IPv4 address, or a domain name (in which case a DNS * address, an IPv4 address, or a domain name (in which case a DNS
* lookup is performed). Quoting with [] is supported for all address * lookup is performed). Quoting with [] is supported for all address
* types. A port override may be specified in the usual way with a * types. A port override may be specified in the usual way with a
@ -923,7 +923,7 @@ g_socket_client_connect (GSocketClient *client,
* used as the port number to connect to. * used as the port number to connect to.
* *
* In general, @host_and_port is expected to be provided by the user (allowing * In general, @host_and_port is expected to be provided by the user (allowing
* them to give the hostname, and a port overide if necessary) and * them to give the hostname, and a port override if necessary) and
* @default_port is expected to be provided by the application. * @default_port is expected to be provided by the application.
* *
* In the case that an IP address is given, a single connection * In the case that an IP address is given, a single connection
@ -1591,7 +1591,7 @@ g_socket_client_connect_to_uri_async (GSocketClient *client,
* g_socket_client_connect_finish: * g_socket_client_connect_finish:
* @client: a #GSocketClient. * @client: a #GSocketClient.
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async connect operation. See g_socket_client_connect_async() * Finishes an async connect operation. See g_socket_client_connect_async()
@ -1617,7 +1617,7 @@ g_socket_client_connect_finish (GSocketClient *client,
* g_socket_client_connect_to_host_finish: * g_socket_client_connect_to_host_finish:
* @client: a #GSocketClient. * @client: a #GSocketClient.
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async connect operation. See g_socket_client_connect_to_host_async() * Finishes an async connect operation. See g_socket_client_connect_to_host_async()
@ -1638,7 +1638,7 @@ g_socket_client_connect_to_host_finish (GSocketClient *client,
* g_socket_client_connect_to_service_finish: * g_socket_client_connect_to_service_finish:
* @client: a #GSocketClient. * @client: a #GSocketClient.
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async connect operation. See g_socket_client_connect_to_service_async() * Finishes an async connect operation. See g_socket_client_connect_to_service_async()
@ -1659,7 +1659,7 @@ g_socket_client_connect_to_service_finish (GSocketClient *client,
* g_socket_client_connect_to_uri_finish: * g_socket_client_connect_to_uri_finish:
* @client: a #GSocketClient. * @client: a #GSocketClient.
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async connect operation. See g_socket_client_connect_to_uri_async() * Finishes an async connect operation. See g_socket_client_connect_to_uri_async()
@ -1684,7 +1684,7 @@ g_socket_client_connect_to_uri_finish (GSocketClient *client,
* Enable proxy protocols to be handled by the application. When the * Enable proxy protocols to be handled by the application. When the
* indicated proxy protocol is returned by the #GProxyResolver, * indicated proxy protocol is returned by the #GProxyResolver,
* #GSocketClient will consider this protocol as supported but will * #GSocketClient will consider this protocol as supported but will
* not try find a #GProxy instance to handle handshaking. The * not try to find a #GProxy instance to handle handshaking. The
* application must check for this case by calling * application must check for this case by calling
* g_socket_connection_get_remote_address() on the returned * g_socket_connection_get_remote_address() on the returned
* #GSocketConnection, and seeing if it's a #GProxyAddress of the * #GSocketConnection, and seeing if it's a #GProxyAddress of the

2
gio/gsocketconnection.c
View File

@ -52,7 +52,7 @@
* depends on the type of the underlying socket that is in use. For * depends on the type of the underlying socket that is in use. For
* instance, for a TCP/IP connection it will be a #GTcpConnection. * instance, for a TCP/IP connection it will be a #GTcpConnection.
* *
* Chosing what type of object to construct is done with the socket * Choosing what type of object to construct is done with the socket
* connection factory, and it is possible for 3rd parties to register * connection factory, and it is possible for 3rd parties to register
* custom socket connection types for specific combination of socket * custom socket connection types for specific combination of socket
* family/type/protocol using g_socket_connection_factory_register_type(). * family/type/protocol using g_socket_connection_factory_register_type().

12
gio/gsocketlistener.c
View File

@ -263,7 +263,7 @@ g_socket_listener_add_socket (GSocketListener *listener,
* *
* Note that adding an IPv6 address, depending on the platform, * Note that adding an IPv6 address, depending on the platform,
* may or may not result in a listener that also accepts IPv4 * may or may not result in a listener that also accepts IPv4
* connections. For more determinstic behaviour, see * connections. For more deterministic behavior, see
* g_socket_listener_add_inet_port(). * g_socket_listener_add_inet_port().
* *
* @source_object will be passed out in the various calls * @source_object will be passed out in the various calls
@ -272,7 +272,7 @@ g_socket_listener_add_socket (GSocketListener *listener,
* different things depending on what address is connected to. * different things depending on what address is connected to.
* *
* If successful and @effective_address is non-%NULL then it will * If successful and @effective_address is non-%NULL then it will
* be set to the address that the binding actually occured at. This * be set to the address that the binding actually occurred at. This
* is helpful for determining the port number that was used for when * is helpful for determining the port number that was used for when
* requesting a binding to port 0 (ie: "any port"). This address, if * requesting a binding to port 0 (ie: "any port"). This address, if
* requested, belongs to the caller and must be freed. * requested, belongs to the caller and must be freed.
@ -770,7 +770,7 @@ g_socket_listener_accept_socket_async (GSocketListener *listener,
* @listener: a #GSocketListener * @listener: a #GSocketListener
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async accept operation. See g_socket_listener_accept_socket_async() * Finishes an async accept operation. See g_socket_listener_accept_socket_async()
@ -837,7 +837,7 @@ g_socket_listener_accept_async (GSocketListener *listener,
* @listener: a #GSocketListener * @listener: a #GSocketListener
* @result: a #GAsyncResult. * @result: a #GAsyncResult.
* @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source * @source_object: (out) (transfer none) (allow-none): Optional #GObject identifying this source
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Finishes an async accept operation. See g_socket_listener_accept_async() * Finishes an async accept operation. See g_socket_listener_accept_async()
@ -928,11 +928,11 @@ g_socket_listener_close (GSocketListener *listener)
* g_socket_listener_add_any_inet_port: * g_socket_listener_add_any_inet_port:
* @listener: a #GSocketListener * @listener: a #GSocketListener
* @source_object: (allow-none): Optional #GObject identifying this source * @source_object: (allow-none): Optional #GObject identifying this source
* @error: a #GError location to store the error occuring, or %NULL to * @error: a #GError location to store the error occurring, or %NULL to
* ignore. * ignore.
* *
* Listens for TCP connections on any available port number for both * Listens for TCP connections on any available port number for both
* IPv6 and IPv4 (if each are available). * IPv6 and IPv4 (if each is available).
* *
* This is useful if you need to have a socket for incoming connections * This is useful if you need to have a socket for incoming connections
* but don't care about the specific port number. * but don't care about the specific port number.

4
gio/gsocketservice.c
View File

@ -34,8 +34,8 @@
* signal is emitted. * signal is emitted.
* *
* A #GSocketService is a subclass of #GSocketListener and you need * A #GSocketService is a subclass of #GSocketListener and you need
* to add the addresses you want to accept connections on to the * to add the addresses you want to accept connections on with the
* with the #GSocketListener APIs. * #GSocketListener APIs.
* *
* There are two options for implementing a network service based on * There are two options for implementing a network service based on
* #GSocketService. The first is to create the service using * #GSocketService. The first is to create the service using

2
gio/gtcpconnection.c
View File

@ -326,7 +326,7 @@ g_tcp_connection_close_async (GIOStream *stream,
* @graceful_disconnect: Whether to do graceful disconnects or not * @graceful_disconnect: Whether to do graceful disconnects or not
* *
* This enabled graceful disconnects on close. A graceful disconnect * This enabled graceful disconnects on close. A graceful disconnect
* means that we signal the recieving end that the connection is terminated * means that we signal the receiving end that the connection is terminated
* and wait for it to close the connection before closing the connection. * and wait for it to close the connection before closing the connection.
* *
* A graceful disconnect means that we can be sure that we successfully sent * A graceful disconnect means that we can be sure that we successfully sent

4
gio/gthreadedsocketservice.c
View File

@ -37,7 +37,7 @@
* until the connection is closed. * until the connection is closed.
* *
* The service is implemented using a thread pool, so there is a * The service is implemented using a thread pool, so there is a
* limited amount of threads availible to serve incomming requests. * limited amount of threads available to serve incoming requests.
* The service automatically stops the #GSocketService from accepting * The service automatically stops the #GSocketService from accepting
* new connections when all threads are busy. * new connections when all threads are busy.
* *
@ -234,7 +234,7 @@ g_threaded_socket_service_class_init (GThreadedSocketServiceClass *class)
* @connection and may perform blocking IO. The signal handler need * @connection and may perform blocking IO. The signal handler need
* not return until the connection is closed. * not return until the connection is closed.
* *
* Returns: %TRUE to stope further signal handlers from being called * Returns: %TRUE to stop further signal handlers from being called
*/ */
g_threaded_socket_service_run_signal = g_threaded_socket_service_run_signal =
g_signal_new ("run", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST, g_signal_new ("run", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,

6
gio/gunixconnection.c
View File

@ -66,8 +66,8 @@ G_DEFINE_TYPE_WITH_CODE (GUnixConnection, g_unix_connection,
* @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
* @error: (allow-none): #GError for error reporting, or %NULL to ignore. * @error: (allow-none): #GError for error reporting, or %NULL to ignore.
* *
* Passes a file descriptor to the recieving side of the * Passes a file descriptor to the receiving side of the
* connection. The recieving end has to call g_unix_connection_receive_fd() * connection. The receiving end has to call g_unix_connection_receive_fd()
* to accept the file descriptor. * to accept the file descriptor.
* *
* As well as sending the fd this also writes a single byte to the * As well as sending the fd this also writes a single byte to the
@ -308,7 +308,7 @@ gboolean g_unix_connection_create_pair (GUnixCo
* @error: Return location for error or %NULL. * @error: Return location for error or %NULL.
* *
* Passes the credentials of the current user the receiving side * Passes the credentials of the current user the receiving side
* of the connection. The recieving end has to call * of the connection. The receiving end has to call
* g_unix_connection_receive_credentials() (or similar) to accept the * g_unix_connection_receive_credentials() (or similar) to accept the
* credentials. * credentials.
* *