Text file src/github.com/mdlayher/socket/README.md

Documentation: github.com/mdlayher/socket

     1# socket [![Test Status](https://github.com/mdlayher/socket/workflows/Test/badge.svg)](https://github.com/mdlayher/socket/actions) [![Go Reference](https://pkg.go.dev/badge/github.com/mdlayher/socket.svg)](https://pkg.go.dev/github.com/mdlayher/socket) [![Go Report Card](https://goreportcard.com/badge/github.com/mdlayher/socket)](https://goreportcard.com/report/github.com/mdlayher/socket)
     2
     3Package `socket` provides a low-level network connection type which integrates
     4with Go's runtime network poller to provide asynchronous I/O and deadline
     5support. MIT Licensed.
     6
     7This package focuses on UNIX-like operating systems which make use of BSD
     8sockets system call APIs. It is meant to be used as a foundation for the
     9creation of operating system-specific socket packages, for socket families such
    10as Linux's `AF_NETLINK`, `AF_PACKET`, or `AF_VSOCK`. This package should not be
    11used directly in end user applications.
    12
    13Any use of package socket should be guarded by build tags, as one would also
    14use when importing the `syscall` or `golang.org/x/sys` packages.
    15
    16## Stability
    17
    18See the [CHANGELOG](./CHANGELOG.md) file for a description of changes between
    19releases.
    20
    21This package only supports the two most recent major versions of Go, mirroring
    22Go's own release policy. Older versions of Go may lack critical features and bug
    23fixes which are necessary for this package to function correctly.

View as plain text