Back to Pocketbase

Interface Conn

static/jsvm/interfaces/net.Conn.html

latest3.6 KB
Original Source

Interface Conn

Conn is a generic stream-oriented network connection.

Multiple goroutines may invoke methods on a Conn simultaneously.

Hierarchy

  • Conn

Indexable

Index

Methods

closelocalAddrreadremoteAddrsetDeadlinesetReadDeadlinesetWriteDeadlinewrite

Methods

close

  • close(): void

Close closes the connection. Any blocked Read or Write operations will be unblocked and return errors.

Returns void

localAddr

LocalAddr returns the local network address, if known.

Returns Addr

read

  • read(b): number

Read reads data from the connection. Read can be made to time out and return an error after a fixed time limit; see SetDeadline and SetReadDeadline.

Parameters

b: string | number[]

Returns number

remoteAddr

  • remoteAddr(): Addr

RemoteAddr returns the remote network address, if known.

Returns Addr

setDeadline

  • setDeadline(t): void

SetDeadline sets the read and write deadlines associated with the connection. It is equivalent to calling both SetReadDeadline and SetWriteDeadline.

A deadline is an absolute time after which I/O operations fail instead of blocking. The deadline applies to all future and pending I/O, not just the immediately following call to Read or Write. After a deadline has been exceeded, the connection can be refreshed by setting a deadline in the future.

If the deadline is exceeded a call to Read or Write or to other I/O methods will return an error that wraps os.ErrDeadlineExceeded. This can be tested using errors.Is(err, os.ErrDeadlineExceeded). The error's Timeout method will return true, but note that there are other possible errors for which the Timeout method will return true even if the deadline has not been exceeded.

An idle timeout can be implemented by repeatedly extending the deadline after successful Read or Write calls.

A zero value for t means I/O operations will not time out.

Parameters

t: Time

Returns void

setReadDeadline

  • setReadDeadline(t): void

SetReadDeadline sets the deadline for future Read calls and any currently-blocked Read call. A zero value for t means Read will not time out.

Parameters

t: Time

Returns void

setWriteDeadline

  • setWriteDeadline(t): void

SetWriteDeadline sets the deadline for future Write calls and any currently-blocked Write call. Even if write times out, it may return n > 0, indicating that some of the data was successfully written. A zero value for t means Write will not time out.

Parameters

t: Time

Returns void

write

  • write(b): number

Write writes data to the connection. Write can be made to time out and return an error after a fixed time limit; see SetDeadline and SetWriteDeadline.

Parameters

b: string | number[]

Returns number

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

On This Page

Generated using TypeDoc