mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-10 11:14:05 +02:00
Add GI annotations to Gio highlevel network functionality
This commit is contained in:
@@ -723,7 +723,7 @@ g_socket_client_class_init (GSocketClientClass *class)
|
|||||||
* g_socket_client_connect:
|
* g_socket_client_connect:
|
||||||
* @client: a #GSocketClient.
|
* @client: a #GSocketClient.
|
||||||
* @connectable: a #GSocketConnectable specifying the remote address.
|
* @connectable: a #GSocketConnectable specifying the remote address.
|
||||||
* @cancellable: 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..
|
||||||
@@ -905,7 +905,7 @@ g_socket_client_connect (GSocketClient *client,
|
|||||||
* @client: a #GSocketClient
|
* @client: a #GSocketClient
|
||||||
* @host_and_port: the name and optionally port of the host to connect to
|
* @host_and_port: the name and optionally port of the host to connect to
|
||||||
* @default_port: the default port to connect to
|
* @default_port: the default port to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @error: a pointer to a #GError, or %NULL
|
* @error: a pointer to a #GError, or %NULL
|
||||||
*
|
*
|
||||||
* This is a helper function for g_socket_client_connect().
|
* This is a helper function for g_socket_client_connect().
|
||||||
@@ -969,7 +969,7 @@ g_socket_client_connect_to_host (GSocketClient *client,
|
|||||||
* @client: a #GSocketConnection
|
* @client: a #GSocketConnection
|
||||||
* @domain: a domain name
|
* @domain: a domain name
|
||||||
* @service: the name of the service to connect to
|
* @service: the name of the service to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @error: a pointer to a #GError, or %NULL
|
* @error: a pointer to a #GError, or %NULL
|
||||||
* @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error
|
* @returns: (transfer full): a #GSocketConnection if successful, or %NULL on error
|
||||||
*
|
*
|
||||||
@@ -1011,7 +1011,7 @@ g_socket_client_connect_to_service (GSocketClient *client,
|
|||||||
* @client: a #GSocketClient
|
* @client: a #GSocketClient
|
||||||
* @uri: A network URI
|
* @uri: A network URI
|
||||||
* @default_port: the default port to connect to
|
* @default_port: the default port to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @error: a pointer to a #GError, or %NULL
|
* @error: a pointer to a #GError, or %NULL
|
||||||
*
|
*
|
||||||
* This is a helper function for g_socket_client_connect().
|
* This is a helper function for g_socket_client_connect().
|
||||||
@@ -1422,9 +1422,9 @@ g_socket_client_enumerator_callback (GObject *object,
|
|||||||
* g_socket_client_connect_async:
|
* g_socket_client_connect_async:
|
||||||
* @client: a #GTcpClient
|
* @client: a #GTcpClient
|
||||||
* @connectable: a #GSocketConnectable specifying the remote address.
|
* @connectable: a #GSocketConnectable specifying the remote address.
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of g_socket_client_connect().
|
* This is the asynchronous version of g_socket_client_connect().
|
||||||
*
|
*
|
||||||
@@ -1471,9 +1471,9 @@ g_socket_client_connect_async (GSocketClient *client,
|
|||||||
* @client: a #GTcpClient
|
* @client: a #GTcpClient
|
||||||
* @host_and_port: the name and optionally the port of the host to connect to
|
* @host_and_port: the name and optionally the port of the host to connect to
|
||||||
* @default_port: the default port to connect to
|
* @default_port: the default port to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of g_socket_client_connect_to_host().
|
* This is the asynchronous version of g_socket_client_connect_to_host().
|
||||||
*
|
*
|
||||||
@@ -1516,9 +1516,9 @@ g_socket_client_connect_to_host_async (GSocketClient *client,
|
|||||||
* @client: a #GSocketClient
|
* @client: a #GSocketClient
|
||||||
* @domain: a domain name
|
* @domain: a domain name
|
||||||
* @service: the name of the service to connect to
|
* @service: the name of the service to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of
|
* This is the asynchronous version of
|
||||||
* g_socket_client_connect_to_service().
|
* g_socket_client_connect_to_service().
|
||||||
@@ -1547,9 +1547,9 @@ g_socket_client_connect_to_service_async (GSocketClient *client,
|
|||||||
* @client: a #GSocketClient
|
* @client: a #GSocketClient
|
||||||
* @uri: a network uri
|
* @uri: a network uri
|
||||||
* @default_port: the default port to connect to
|
* @default_port: the default port to connect to
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of g_socket_client_connect_to_uri().
|
* This is the asynchronous version of g_socket_client_connect_to_uri().
|
||||||
*
|
*
|
||||||
|
@@ -199,7 +199,7 @@ check_listener (GSocketListener *listener,
|
|||||||
* g_socket_listener_add_socket:
|
* g_socket_listener_add_socket:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @socket: a listening #GSocket
|
* @socket: a listening #GSocket
|
||||||
* @source_object: Optional #GObject identifying this source
|
* @source_object: (allow-none): Optional #GObject identifying this source
|
||||||
* @error: #GError for error reporting, or %NULL to ignore.
|
* @error: #GError for error reporting, or %NULL to ignore.
|
||||||
*
|
*
|
||||||
* Adds @socket to the set of sockets that we try to accept
|
* Adds @socket to the set of sockets that we try to accept
|
||||||
@@ -253,7 +253,7 @@ g_socket_listener_add_socket (GSocketListener *listener,
|
|||||||
* @address: a #GSocketAddress
|
* @address: a #GSocketAddress
|
||||||
* @type: a #GSocketType
|
* @type: a #GSocketType
|
||||||
* @protocol: a #GSocketProtocol
|
* @protocol: a #GSocketProtocol
|
||||||
* @source_object: Optional #GObject identifying this source
|
* @source_object: (allow-none): Optional #GObject identifying this source
|
||||||
* @effective_address: (out) (allow-none): location to store the address that was bound to, or %NULL.
|
* @effective_address: (out) (allow-none): location to store the address that was bound to, or %NULL.
|
||||||
* @error: #GError for error reporting, or %NULL to ignore.
|
* @error: #GError for error reporting, or %NULL to ignore.
|
||||||
*
|
*
|
||||||
@@ -344,7 +344,7 @@ g_socket_listener_add_address (GSocketListener *listener,
|
|||||||
* g_socket_listener_add_inet_port:
|
* g_socket_listener_add_inet_port:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @port: an IP port number (non-zero)
|
* @port: an IP port number (non-zero)
|
||||||
* @source_object: Optional #GObject identifying this source
|
* @source_object: (allow-none): Optional #GObject identifying this source
|
||||||
* @error: #GError for error reporting, or %NULL to ignore.
|
* @error: #GError for error reporting, or %NULL to ignore.
|
||||||
*
|
*
|
||||||
* Helper function for g_socket_listener_add_address() that
|
* Helper function for g_socket_listener_add_address() that
|
||||||
@@ -563,7 +563,7 @@ accept_callback (GSocket *socket,
|
|||||||
* g_socket_listener_accept_socket:
|
* g_socket_listener_accept_socket:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL.
|
* @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL.
|
||||||
* @cancellable: 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.
|
||||||
*
|
*
|
||||||
* Blocks waiting for a client to connect to any of the sockets added
|
* Blocks waiting for a client to connect to any of the sockets added
|
||||||
@@ -640,7 +640,7 @@ g_socket_listener_accept_socket (GSocketListener *listener,
|
|||||||
* g_socket_listener_accept:
|
* g_socket_listener_accept:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL
|
* @source_object: (out) (transfer none) (allow-none): location where #GObject pointer will be stored, or %NULL
|
||||||
* @cancellable: 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.
|
||||||
*
|
*
|
||||||
* Blocks waiting for a client to connect to any of the sockets added
|
* Blocks waiting for a client to connect to any of the sockets added
|
||||||
@@ -724,9 +724,9 @@ accept_ready (GSocket *accept_socket,
|
|||||||
/**
|
/**
|
||||||
* g_socket_listener_accept_socket_async:
|
* g_socket_listener_accept_socket_async:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of g_socket_listener_accept_socket().
|
* This is the asynchronous version of g_socket_listener_accept_socket().
|
||||||
*
|
*
|
||||||
@@ -769,7 +769,7 @@ g_socket_listener_accept_socket_async (GSocketListener *listener,
|
|||||||
* g_socket_listener_accept_socket_finish:
|
* g_socket_listener_accept_socket_finish:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @result: a #GAsyncResult.
|
* @result: a #GAsyncResult.
|
||||||
* @source_object: 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 occuring, or %NULL to
|
||||||
* ignore.
|
* ignore.
|
||||||
*
|
*
|
||||||
@@ -808,9 +808,9 @@ g_socket_listener_accept_socket_finish (GSocketListener *listener,
|
|||||||
/**
|
/**
|
||||||
* g_socket_listener_accept_async:
|
* g_socket_listener_accept_async:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @cancellable: a #GCancellable, or %NULL
|
* @cancellable: (allow-none): a #GCancellable, or %NULL
|
||||||
* @callback: a #GAsyncReadyCallback
|
* @callback: (scope async): a #GAsyncReadyCallback
|
||||||
* @user_data: user data for the callback
|
* @user_data: (closure): user data for the callback
|
||||||
*
|
*
|
||||||
* This is the asynchronous version of g_socket_listener_accept().
|
* This is the asynchronous version of g_socket_listener_accept().
|
||||||
*
|
*
|
||||||
@@ -836,7 +836,7 @@ g_socket_listener_accept_async (GSocketListener *listener,
|
|||||||
* g_socket_listener_accept_finish:
|
* g_socket_listener_accept_finish:
|
||||||
* @listener: a #GSocketListener
|
* @listener: a #GSocketListener
|
||||||
* @result: a #GAsyncResult.
|
* @result: a #GAsyncResult.
|
||||||
* @source_object: 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 occuring, or %NULL to
|
||||||
* ignore.
|
* ignore.
|
||||||
*
|
*
|
||||||
@@ -927,7 +927,7 @@ 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: 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 occuring, or %NULL to
|
||||||
* ignore.
|
* ignore.
|
||||||
*
|
*
|
||||||
|
@@ -304,7 +304,7 @@ gboolean g_unix_connection_create_pair (GUnixCo
|
|||||||
/**
|
/**
|
||||||
* g_unix_connection_send_credentials:
|
* g_unix_connection_send_credentials:
|
||||||
* @connection: A #GUnixConnection.
|
* @connection: A #GUnixConnection.
|
||||||
* @cancellable: A #GCancellable or %NULL.
|
* @cancellable: (allow-none): A #GCancellable or %NULL.
|
||||||
* @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
|
||||||
@@ -372,7 +372,7 @@ g_unix_connection_send_credentials (GUnixConnection *connection,
|
|||||||
/**
|
/**
|
||||||
* g_unix_connection_receive_credentials:
|
* g_unix_connection_receive_credentials:
|
||||||
* @connection: A #GUnixConnection.
|
* @connection: A #GUnixConnection.
|
||||||
* @cancellable: A #GCancellable or %NULL.
|
* @cancellable: (allow-none): A #GCancellable or %NULL.
|
||||||
* @error: Return location for error or %NULL.
|
* @error: Return location for error or %NULL.
|
||||||
*
|
*
|
||||||
* Receives credentials from the sending end of the connection. The
|
* Receives credentials from the sending end of the connection. The
|
||||||
|
Reference in New Issue
Block a user