socket

package

v0.4.0 Latest Latest Go to latest Published: Oct 10, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AiCoded-Dev/framework

Links

Open Source Insights

Documentation ¶

Overview ¶

Package socket connects apps and runners over Unix sockets using HTTP/2 without TLS.

Index ¶

Constants
func Client(path string) *http.Client
func Listen(ctx context.Context, path string) (net.Listener, error)
func ListenShared(ctx context.Context, path string) (net.Listener, error)
func NewServer(h http.Handler) *http.Server
func Share(path string) error

Constants ¶

View Source

const BaseURL = "http://runner"

BaseURL is the base URL for clients returned by Client; the host part is ignored.

Variables ¶

This section is empty.

Functions ¶

func Client ¶

func Client(path string) *http.Client

Client returns an HTTP/2 client that dials the Unix socket at path.

func Listen ¶

func Listen(ctx context.Context, path string) (net.Listener, error)

Listen creates a Unix socket at path that only its owner can use, replacing a stale one.

func ListenShared ¶ added in v0.4.0

func ListenShared(ctx context.Context, path string) (net.Listener, error)

ListenShared creates a Unix socket at path as Listen does, then makes it usable by every user as Share does.

func NewServer ¶

func NewServer(h http.Handler) *http.Server

NewServer returns a server for h that speaks HTTP/1.1 and HTTP/2 without TLS and has timeouts set. A stream that moves in neither direction for 60 seconds is cut; one that keeps moving may run as long as it needs.

func Share(path string) error

Share makes the socket at path, which Listen made, usable by every user: for a peer that runs as another user. The folder the socket is in then decides who reaches it. It refuses anything at path but a socket.

Types ¶