getsockopt, setsockopt − Lire et écrire les options d’une socket.

#include <sys/types.h>
#include <sys/socket.h>

int getsockopt(int s, int level, int optname, void *optval, socklen_t *optlen);

int setsockopt(int s, int level, int optname, const void *optval, socklen_t optlen);

getsockopt() et setsockopt() manipulent les options associées à une socket. Ces options peuvent exister aux divers niveaux du protocole, et sont toujours présentes au niveau socket le plus élevé.

Quand on manipule une option d’une socket, il faut préciser le niveau où elle s’applique, et le nom de l’option. Au niveau socket, level prend la valeur SOL_SOCKET. Pour tous les autres niveaux, il faut fournir le numéro de protocole approprié. Par exemple, pour une option interprétée par le niveau de protocole TCP, level prendra le numéro de protocole TCP. Voir getprotoent(3).

Les paramètres optval et optlen sont utilisés pour déterminer les options pour setsockopt(). Pour getsockopt() ils identifient un tampon dans lequel la valeur de l’option désirée doit être renvoyée. Pour getsockopt(), optlen est un paramètre résultat, contenant initialement la taille du tampon pointé par optval, et rempli en retour pour indiquer la taille effective des valeurs renvoyées. Si aucune option n’est fournie ou renvoyée, optval peut être NULL.

optname et toute autre option sont passés sans interprétation au protocole approprié, pour qu’il l’interprète lui-même. Le fichier d’en-tête sys/socket.h contient les définitions pour le niveau socket. Les options pour les autres niveaux de protocole, peuvent varier tant en format qu’en nom, consulter les pages de manuel de la section 7 pour plus d’informations.

La plupart des options au niveau socket utilisent un paramètre de type int pour optval. Pour setsockopt(), un paramètre non nul valide une option booléenne, et zéro l’invalide.

Pour une description des options disponibles voir socket(7) et les pages correspondant au protocole concerné.

getsockopt et setsockopt renvoient 0 s’ils réussissent, ou −1 s’ils échouent, auquel cas errno contient le code d’erreur.

EBADF

L’argument s n’est pas un descripteur valide.

EFAULT

optval pointe en dehors de l’espace d’adressage accessible. Avec getsockopt(), ceci peut s’appliquer également à optlen.

EINVAL

optlen n’est pas valide dans setsockopt().

ENOPROTOOPT

L’option est inconnue pour ce protocole.

ENOTSOCK

L’argument s est un fichier, pas une socket.

SVr4, BSD 4.4 (Ces appels système sont apparus dans BSD 4.2), POSIX.1-2001.

L’argument optlen de getsockopt et setsockopt est en fait un int [*] (et c’est ce qu’utilisent BSD 4.*, libc4 et libc5). Une certaine confusion POSIX résulte du socklen_t actuel, également utilisé par la glibc. Pour plus de détails voir accept(2).

Plusieurs options sur les sockets devraient être gérées à un niveau plus bas par le système.

ioctl(2), socket(2), getprotoent(3), protocols(5), socket(7), tcp(7), unix(7)

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 11 octobre 1996 et révisée le 14 août 2006.

L’équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 2 getsockopt ». N’hésitez pas à signaler à l’auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.