luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-02 15:33:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove protocol names, instead use an enum with common protocols

Browse Source 
The whole protocol name thing is pretty weird. The getprotobyname functions
seem to only specify one mapping for name <-> ids, so all families/types
must use the same values. Plus the values used for the protocols are
standardized by IANA, so are always the same.

So, we drop using names for protocols, intead introducing an enum with
a few commonly availible and used protocols.
This commit is contained in:
Alexander Larsson
2009-05-20 12:01:29 +02:00
parent 6d01593b06
commit 5cd86fbda6
16 changed files with 417 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
gio/gsocket.c
View File

@@ -132,7 +132,7 @@ struct _GSocketPrivate
{
GSocketFamily family;
GSocketType type;
gint protocol;
GSocketProtocol protocol;
gint fd;
gint listen_backlog;
GError *construct_error;
@@ -400,88 +400,10 @@ g_socket_details_from_fd (GSocket *socket)
socket_strerror (errsv));
}
static char *
get_protocol_name (int protocol_id)
{
struct protoent *protoent;
#ifdef HAVE_GETPROTOBYNUMBER_R
char buffer[1024];
struct protoent my_protoent;
#endif
if (protocol_id == 0)
return NULL;
if (protocol_id == -1)
return g_strdup ("unknown");
#ifdef HAVE_GETPROTOBYNUMBER_R
protoent = NULL;
getprotobynumber_r (protocol_id,
&my_protoent, buffer, sizeof (buffer),
&protoent);
#else
protoent = getprotobynumber (protocol_id);
#endif
if (protoent == NULL)
return g_strdup_printf ("proto-%d", protocol_id);
return g_strdup (protoent->p_name);
}
/**
* g_socket_protocol_id_lookup_by_name:
* @protocol_name: The name of a protocol, or %NULL
*
* Tries to look up the protocol id for a given
* protocol name. If the protocol name is not known
* on this system it returns -1.
*
* If @protocol_name is %NULL (default protocol) then
* 0 is returned.
*
* Returns: a protocol id, or -1 if unknown
*
* Since: 2.22
**/
gint
g_socket_protocol_id_lookup_by_name (const char *protocol_name)
{
struct protoent *protoent;
int protocol = 0;
#ifdef HAVE_GETPROTOBYNAME_R
char buffer[1024];
struct protoent my_protoent;
#endif
if (!protocol_name)
return 0;
#ifdef HAVE_GETPROTOBYNAME_R
protoent = NULL;
getprotobyname_r (protocol_name,
&my_protoent, buffer, sizeof (buffer),
&protoent);
#else
protoent = getprotobyname (protocol_name);
#endif
if (protoent == NULL)
{
if (g_str_has_prefix (protocol_name, "proto-"))
return atoi (protocol_name + strlen ("proto-"));
return -1;
}
protocol = protoent->p_proto;
return protocol;
}
static gint
g_socket_create_socket (GSocketFamily family,
GSocketType type,
int protocol_id,
int protocol,
GError **error)
{
gint native_type;
@@ -505,7 +427,7 @@ g_socket_create_socket (GSocketFamily family,
g_assert_not_reached ();
}
if (protocol_id == -1)
if (protocol == -1)
{
g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
_("Unable to create socket: %s"), _("Unknown protocol was specified"));
@@ -515,7 +437,7 @@ g_socket_create_socket (GSocketFamily family,
#ifdef SOCK_CLOEXEC
native_type |= SOCK_CLOEXEC;
#endif
fd = socket (family, native_type, protocol_id);
fd = socket (family, native_type, protocol);
if (fd < 0)
{
@@ -589,7 +511,7 @@ g_socket_get_property (GObject *object,
break;
case PROP_PROTOCOL:
g_value_set_int (value, socket->priv->protocol);
g_value_set_enum (value, socket->priv->protocol);
break;
case PROP_FD:
@@ -642,7 +564,7 @@ g_socket_set_property (GObject *object,
break;
case PROP_PROTOCOL:
socket->priv->protocol = g_value_get_int (value);
socket->priv->protocol = g_value_get_enum (value);
break;
case PROP_FD:
@@ -718,12 +640,11 @@ g_socket_class_init (GSocketClass *klass)
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_PROTOCOL,
g_param_spec_int ("protocol",
g_param_spec_enum ("protocol",
P_("Socket protocol"),
P_("The id of the protocol to use, or -1 for unknown"),
G_MININT,
G_MAXINT,
-1,
G_TYPE_SOCKET_PROTOCOL,
G_SOCKET_PROTOCOL_UNKNOWN,
G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (gobject_class, PROP_FD,
@@ -828,20 +749,22 @@ g_socket_initable_init (GInitable *initable,
* g_socket_new:
* @family: the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4.
* @type: the socket type to use.
* @protocol_id: the id of the protocol to use, or 0 for default.
* @protocol: the id of the protocol to use, or 0 for default.
* @error: #GError for error reporting, or %NULL to ignore.
*
* Creates a new #GSocket with the defined family, type and protocol.
* If @protocol_id is 0 the default protocol type for the family and
* type is used.
* If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type
* for the family and type is used.
*
* The @protocol_id is a family and type specific int that specifies what
* kind of protocol to use. Many families only support one protocol,
* and use 0 for this, others support several and using 0 means
* to use the default protocol for the family and type. To use
* other protocol, you can use g_socket_protocol_id_lookup_by_name()
* to look up the protocol by name, or if you known the system specific
* protocol id you can use that.
* The @protocol is a family and type specific int that specifies what
* kind of protocol to use. #GSocketProtocol lists several common ones.
* Many families only support one protocol, and use 0 for this, others
* support several and using 0 means to use the default protocol for
* the family and type.
*
* The protocol id is passed directly to the operating
* system, so you can use protocols not listed in #GSocketProtocol if you
* know the protocol number used for it.
*
* Returns: a #GSocket or %NULL on error.
* Free the returned object with g_object_unref().
@@ -851,14 +774,14 @@ g_socket_initable_init (GInitable *initable,
GSocket *
g_socket_new (GSocketFamily family,
GSocketType type,
int protocol_id,
GSocketProtocol protocol,
GError **error)
{
return G_SOCKET (g_initable_new (G_TYPE_SOCKET,
NULL, error,
"family", family,
"type", type,
"protocol", protocol_id,
"protocol", protocol,
NULL));
}
@@ -1089,7 +1012,7 @@ g_socket_get_socket_type (GSocket *socket)
}
/**
* g_socket_get_protocol_id:
* g_socket_get_protocol:
* @socket: a #GSocket.
*
* Gets the socket protocol id the socket was created with.
@@ -1099,33 +1022,14 @@ g_socket_get_socket_type (GSocket *socket)
*
* Since: 2.22
**/
gint
g_socket_get_protocol_id (GSocket *socket)
GSocketProtocol
g_socket_get_protocol (GSocket *socket)
{
g_return_val_if_fail (G_IS_SOCKET (socket), -1);
return socket->priv->protocol;
}
/**
* g_socket_get_protocol_name:
* @socket: a #GSocket.
*
* Gets the socket protocol type name the socket was created with.
* This can be %NULL if the socket was created with a NULL protocol.
*
* Returns: a string or %NULL, free with g_free
*
* Since: 2.22
**/
char *
g_socket_get_protocol_name (GSocket *socket)
{
g_return_val_if_fail (G_IS_SOCKET (socket), NULL);
return get_protocol_name (socket->priv->protocol);
}
/**
* g_socket_get_fd:
* @socket: a #GSocket.