package fasthttputil

Import Path
	github.com/valyala/fasthttp/fasthttputil (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package fasthttputil provides utility functions for fasthttp.

	    inmemory_listener.go
	    pipeconns.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type InmemoryListener (struct)
		InmemoryListener provides in-memory dialer<->net.Listener implementation.
		
		It may be used either for fast in-process client<->server communications
		without network stack overhead or for client<->server tests.

		Methods (total 6)
			(*InmemoryListener) Accept() (net.Conn, error)
				Accept implements net.Listener's Accept.
				
				It is safe calling Accept from concurrently running goroutines.
				
				Accept returns new connection per each Dial call.

			(*InmemoryListener) Addr() net.Addr
				Addr implements net.Listener's Addr.

			(*InmemoryListener) Close() error
				Close implements net.Listener's Close.

			(*InmemoryListener) Dial() (net.Conn, error)
				Dial creates new client<->server connection.
				Just like a real Dial it only returns once the server
				has accepted the connection.
				
				It is safe calling Dial from concurrently running goroutines.

			(*InmemoryListener) DialWithLocalAddr(local net.Addr) (net.Conn, error)
				DialWithLocalAddr creates new client<->server connection.
				Just like a real Dial it only returns once the server
				has accepted the connection. The local address of the
				client connection can be set with local.
				
				It is safe calling Dial from concurrently running goroutines.

			(*InmemoryListener) SetLocalAddr(localAddr net.Addr)
				SetLocalAddr sets the (simulated) local address for the listener.

		Implements (at least 2)
			*InmemoryListener : io.Closer
			*InmemoryListener : net.Listener
		As Outputs Of (at least one exported)
			func NewInmemoryListener() *InmemoryListener

	 type PipeConns (struct)
		PipeConns provides bi-directional connection pipe,
		which use in-process memory as a transport.
		
		PipeConns must be created by calling NewPipeConns.
		
		PipeConns has the following additional features comparing to connections
		returned from net.Pipe():
		
		  - It is faster.
		  - It buffers Write calls, so there is no need to have concurrent goroutine
		    calling Read in order to unblock each Write call.
		  - It supports read and write deadlines.
		
		PipeConns is NOT safe for concurrent use by multiple goroutines!

		Methods (total 4)
			(*PipeConns) Close() error
				Close closes pipe connections.

			(*PipeConns) Conn1() net.Conn
				Conn1 returns the first end of bi-directional pipe.
				
				Data written to Conn1 may be read from Conn2.
				Data written to Conn2 may be read from Conn1.

			(*PipeConns) Conn2() net.Conn
				Conn2 returns the second end of bi-directional pipe.
				
				Data written to Conn2 may be read from Conn1.
				Data written to Conn1 may be read from Conn2.

			(*PipeConns) SetAddresses(localAddr1, remoteAddr1, localAddr2, remoteAddr2 net.Addr)
				SetAddresses sets the local and remote addresses for the connection.

		Implements (at least one exported)
			*PipeConns : io.Closer
		As Outputs Of (at least one exported)
			func NewPipeConns() *PipeConns


Package-Level Functions (total 2)

	 func NewInmemoryListener() *InmemoryListener
		NewInmemoryListener returns new in-memory dialer<->net.Listener.

	 func NewPipeConns() *PipeConns
		NewPipeConns returns new bi-directional connection pipe.
		
		PipeConns is NOT safe for concurrent use by multiple goroutines!


Package-Level Variables (total 2)

	  var ErrInmemoryListenerClosed error
		ErrInmemoryListenerClosed indicates that the InmemoryListener is already closed.

	  var ErrTimeout *timeoutError
		ErrTimeout is returned from Read() or Write() on timeout.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.