Stdlib module network/socket.vitl

This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.

Visual portrait of network/socket.vitl
Wiki-style portrait for network/socket.vitl.

Family: stdlib

Kind: public stdlib surface

Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.

Summary

Overview

FieldValue
Pathnetwork/socket.vitl
Familystdlib
Kindpublic stdlib surface
Line count50
Declared procedures5
Declared forms/picks2

`network/socket.vitl` is a public stdlib surface inside the `stdlib` family. It should be read as one focused slice of the broader family responsibility: Top-level map of the Vitte standard library and the responsibilities owned by each family.

Purpose

This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the stdlib family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.

  • Domain values start in `core` and `strings`.
  • Grouped data moves through `collections` or `data`.
  • Structured export goes through `json` and `encoding`.
  • Filesystem or process interaction goes through `path`, `io`, `os`, or `sysinfo`.
  • Explicit runtime coordination goes through `async`, `threading`, `kernel`, or `ffi`.

Taxonomy

Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.

  • Compact procedure surface: this file is small enough to read end-to-end before depending on it.
  • Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
  • Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
  • Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.

Implementation profile

This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.

SignalCountWhat it suggests
if0Branching density and local decision-making.
while0Loop-heavy or iterative implementation style.
for0Collection-style traversal at source level.
match0Variant-driven branching or grammar-style decoding.
let0Local state and intermediate value density.
give5Number of explicit exit points and result shaping.

Top-level API inventory

SurfaceItems
Proceduressocket_address, tcp_socket_new, tcp_socket_connect, tcp_socket_set_nonblocking, tcp_socket_ready
FormsSocketAddress, TcpSocket
Picksnone declared at top level
Constantsnone declared at top level
Exports*

Imported surfaces

This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.

Position in family

This file is module 8 of 15 in the stdlib family when ordered by path. By procedure count it ranks 11, and by line count it ranks 10. Those ranks are useful as rough signals of breadth, not as quality judgments.

Declaration map

The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.

LineNameKindRole
1vitte/stdlib/network/socketspaceDeclares the namespace that anchors this file in the stdlib tree.
5SocketAddressformIntroduces a structured data shape that other procedures can exchange.
10TcpSocketformIntroduces a structured data shape that other procedures can exchange.
17socket_addressprocRepresents one top-level surface in the file contract and should be read as part of the module boundary.
21tcp_socket_newprocRepresents one top-level surface in the file contract and should be read as part of the module boundary.
30tcp_socket_connectprocRepresents one top-level surface in the file contract and should be read as part of the module boundary.
39tcp_socket_set_nonblockingprocOwns a concrete data shape or the operations that maintain it.
48tcp_socket_readyprocRepresents one top-level surface in the file contract and should be read as part of the module boundary.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 8 matching surfaces.

Representative signatures

These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.

  • form SocketAddress { (line 5)
  • form TcpSocket { (line 10)
  • proc socket_address(host: string, port: u64) -> SocketAddress { (line 17)
  • proc tcp_socket_new(host: string, port: u64) -> TcpSocket { (line 21)
  • proc tcp_socket_connect(socket: TcpSocket) -> TcpSocket { (line 30)
  • proc tcp_socket_set_nonblocking(socket: TcpSocket, enabled: bool) -> TcpSocket { (line 39)
  • proc tcp_socket_ready(socket: TcpSocket) -> bool { (line 48)

How to use this module

Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.

  1. Read space and top-level imports first so the ownership boundary of network/socket.vitl is explicit.
  2. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
  3. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
  4. Only after that compare neighbor modules, because the right boundary choice matters more than memorizing one helper name.

User example

This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.

space demo/network_socket
form DemoState {
  ready: bool,
  note: string
}
proc run_example() -> DemoState {
  let ready: bool = tcp_socket_ready(TcpSocket())
  give DemoState { ready: ready, note: "ok" }
}
export run_example

Keyword coverage

This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.

KeywordPresent in module sourceUsed in generated user example
spaceyesyes
formyesyes
procyesyes
giveyesyes
exportyesyes
trueyesno
falseyesno
andyesno

Keywords still not exercised directly in the generated snippet: true, false, and. The page still lists them here so the gap is visible.

Source shape

space vitte/stdlib/network/socket
export *
form SocketAddress {
  host: string
  port: u64
}
form TcpSocket {
  fd: int
  address: SocketAddress
  connected: bool

The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.

Source landmarks

Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.

  • Line 1: space vitte/stdlib/network/socket
  • Line 3: export *
  • Line 5: form SocketAddress {
  • Line 10: form TcpSocket {
  • Line 17: proc socket_address(host: string, port: u64) -> SocketAddress {
  • Line 21: proc tcp_socket_new(host: string, port: u64) -> TcpSocket {
  • Line 30: proc tcp_socket_connect(socket: TcpSocket) -> TcpSocket {
  • Line 39: proc tcp_socket_set_nonblocking(socket: TcpSocket, enabled: bool) -> TcpSocket {

Source organization

When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.

File surfaces

Top-level items: 9. Procedures: 5. Data surfaces: 2. Constants: 0.

First visible names: vitte/stdlib/network/socket, *, SocketAddress, TcpSocket, socket_address, tcp_socket_new, tcp_socket_connect, tcp_socket_set_nonblocking, tcp_socket_ready

Complete API catalog

This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.

Data surfaces

LineNameSignatureRole
5SocketAddressform SocketAddress {Introduces a structured data shape that other procedures can exchange.
10TcpSocketform TcpSocket {Introduces a structured data shape that other procedures can exchange.

Procedures

LineNameSignatureRole
17socket_addressproc socket_address(host: string, port: u64) -> SocketAddress {Represents one top-level surface in the file contract and should be read as part of the module boundary.
21tcp_socket_newproc tcp_socket_new(host: string, port: u64) -> TcpSocket {Represents one top-level surface in the file contract and should be read as part of the module boundary.
30tcp_socket_connectproc tcp_socket_connect(socket: TcpSocket) -> TcpSocket {Represents one top-level surface in the file contract and should be read as part of the module boundary.
39tcp_socket_set_nonblockingproc tcp_socket_set_nonblocking(socket: TcpSocket, enabled: bool) -> TcpSocket {Owns a concrete data shape or the operations that maintain it.
48tcp_socket_readyproc tcp_socket_ready(socket: TcpSocket) -> bool {Represents one top-level surface in the file contract and should be read as part of the module boundary.

Exports

LineNameSignatureRole
3*export *Re-exports surfaces that the module wants to expose as part of its public boundary.

Integration boundaries

Within stdlib, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.

  • Family responsibility: Top-level map of the Vitte standard library and the responsibilities owned by each family.
  • Family architecture role: A realistic Vitte program usually starts in `core`, grows through `collections` or `data`, crosses textual boundaries with `json` or `encoding`, touches the host with `path` or `io`, and only then reaches system-facing families like `kernel`, `ffi`, `async`, or `threading`.

Composition guidance

Choose this module when

  • Choose network/socket.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
  • Domain values start in `core` and `strings`.
  • Grouped data moves through `collections` or `data`.
  • Structured export goes through `json` and `encoding`.
  • Filesystem or process interaction goes through `path`, `io`, `os`, or `sysinfo`.
  • Explicit runtime coordination goes through `async`, `threading`, `kernel`, or `ffi`.

Pause before extending it when

  • Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside stdlib.
  • Check nearby modules such as GETTING_STARTED.vitl, core_alias.vitl, datetime.vitl before adding convenience wrappers here.

Relationship table

This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.

NeighborProceduresData surfacesWhy compare it
GETTING_STARTED.vitl260Shares the same family boundary but carries a distinct slice of responsibility.
core_alias.vitl00Shares the same family boundary but carries a distinct slice of responsibility.
datetime.vitl13816Shares the same family boundary but carries a distinct slice of responsibility.
graphics.vitl50Shares the same family boundary but carries a distinct slice of responsibility.
memory.vitl13716Shares the same family boundary but carries a distinct slice of responsibility.
mod.vit162Shares the same family boundary but carries a distinct slice of responsibility.
network/http.vitl42Shares the same family boundary but carries a distinct slice of responsibility.
network/udp.vitl32Shares the same family boundary but carries a distinct slice of responsibility.

Neighbor modules