BIO_CONNECT(3ossl)

📦 version 3.5.0, in opensuse-leap 16.0

💖 NAME 💖

Hey bestie, welcome to the 3ossl manual page for the socket setup squad! Meet BIO_socket, BIO_bind, BIO_connect, BIO_listen, BIO_accept_ex, and BIO_closesocket — together they're the BIO socket communication setup routines. 💅✨

🎀 SYNOPSIS 🎀

#include <openssl/bio.h>

int BIO_socket(int domain, int socktype, int protocol, int options);
int BIO_bind(int sock, const BIO_ADDR *addr, int options);
int BIO_connect(int sock, const BIO_ADDR *addr, int options);
int BIO_listen(int sock, const BIO_ADDR *addr, int options);
int BIO_accept_ex(int accept_sock, BIO_ADDR *peer, int options);
int BIO_closesocket(int sock);

🌸 DESCRIPTION 🌸

Okay so here's the whole vibe, one function at a time:

  • BIO_socket() — creates a socket in the domain domain, of type socktype, and with protocol. The options argument is currently unused, but it's present for future use. Lowkey just sitting there being iconic for later. 🫶
  • BIO_bind() — binds the source address and service to a socket, and it may be useful before calling BIO_connect(). The options may include BIO_SOCK_REUSEADDR, which is described in FLAGS below. ✨
  • BIO_connect() — connects sock to the address and service given by addr. Connection options may be zero or any combination of BIO_SOCK_KEEPALIVE, BIO_SOCK_NONBLOCK, and BIO_SOCK_NODELAY. The flags are described in FLAGS below. 💖
  • BIO_listen() — has sock start listening on the address and service given by addr. Connection options may be zero or any combination of BIO_SOCK_KEEPALIVE, BIO_SOCK_NONBLOCK, BIO_SOCK_NODELAY, BIO_SOCK_REUSEADDR, and BIO_SOCK_V6_ONLY. The flags are described in FLAGS below. 👑
  • BIO_accept_ex() — waits for incoming connections on the given socket accept_sock. When it gets a connection, the address and port of the peer get stored in peer if that one is non-NULL. Accept options may be zero or BIO_SOCK_NONBLOCK, and it's applied on the accepted socket. The flags are described in FLAGS below. 🦋
  • BIO_closesocket() — closes sock. That's it. That's the whole job. 💀

🌈 FLAGS 🌈

These are the little option besties you can pass around. They're bit flags, so combine them with the "|" operator, bestie.

  • BIO_SOCK_KEEPALIVE — enables regular sending of keep-alive messages. 💌
  • BIO_SOCK_NONBLOCK — sets the socket to nonblocking mode. No waiting around, main character energy. ⚡
  • BIO_SOCK_NODELAY — corresponds to TCP_NODELAY, and disables the Nagle algorithm. With this set, any data will be sent as soon as possible instead of being buffered until there's enough for the socket to send out in one go. Fr fr, no buffering drama. 🔥
  • BIO_SOCK_REUSEADDR — try to reuse the address and port combination for a recently closed port. Recycling, but make it socket behavior. ♻️
  • BIO_SOCK_V6_ONLY — when creating an IPv6 socket, make it only listen for IPv6 addresses and not IPv4 addresses mapped to IPv6. Strictly IPv6, no imposters. 🚫
  • BIO_SOCK_TFO — enables TCP Fast Open on the socket. Uses appropriate APIs on supported operating systems, including Linux, macOS and FreeBSD. Can be used with BIO_connect(), BIO_set_conn_mode(), BIO_set_bind_mode(), and BIO_listen(). On Linux kernels before 4.14, use BIO_set_conn_address() to specify the peer address before starting the TLS handshake. Speedy handshake vibes, iykyk. 🚀

These flags are bit flags, so they are to be combined with the "|" operator, for example:

BIO_connect(sock, addr, BIO_SOCK_KEEPALIVE | BIO_SOCK_NONBLOCK);

💜 RETURN VALUES 💜

  • BIO_socket() returns the socket number on success or INVALID_SOCKET (-1) on error. When an error has occurred, the OpenSSL error stack will hold the error data and errno has the system error. 😭
  • BIO_bind(), BIO_connect(), and BIO_listen() return 1 on success or 0 on error. When an error has occurred, the OpenSSL error stack will hold the error data and errno has the system error. 🫶
  • BIO_accept_ex() returns the accepted socket on success or INVALID_SOCKET (-1) on error. When an error has occurred, the OpenSSL error stack will hold the error data and errno has the system error. 💅

🦋 SEE ALSO 🦋

⭐ HISTORY ⭐

BIO_gethostname(), BIO_get_port(), BIO_get_host_ip(), BIO_get_accept_socket() and BIO_accept() were deprecated in OpenSSL 1.1.0. Use the functions described above instead. We love an upgrade era. ✨

Copyright 2016-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

Catch you later, bestie — this iconic little page is from version 3.5.0, dated 2026-09-25, and it's literally BIO_CONNECT(3ossl). 💖✨💅

📦 where this page comes from