Documentation
¶
Index ¶
- Variables
- func NewIpcClient(cfg IpcConfig, codec codec.Codec) (*ipcClient, error)
- func StartIpc(cfg IpcConfig, codec codec.Codec, apis ...api.EthereumApi) error
- type EthereumClient
- type IpcConfig
- type PipeAddr
- type PipeConn
- func (c *PipeConn) Close() error
- func (c *PipeConn) LocalAddr() net.Addr
- func (c *PipeConn) Read(b []byte) (int, error)
- func (c *PipeConn) RemoteAddr() net.Addr
- func (c *PipeConn) SetDeadline(t time.Time) error
- func (c *PipeConn) SetReadDeadline(t time.Time) error
- func (c *PipeConn) SetWriteDeadline(t time.Time) error
- func (c *PipeConn) Write(b []byte) (int, error)
- type PipeError
- type PipeListener
Constants ¶
This section is empty.
Variables ¶
var ErrClosed = PipeError{"Pipe has been closed.", false}
ErrClosed is the error returned by PipeListener.Accept when Close is called on the PipeListener.
Functions ¶
func NewIpcClient ¶
Create a new IPC client, UNIX domain socket on posix, named pipe on Windows
Types ¶
type EthereumClient ¶
type PipeAddr ¶
type PipeAddr string
PipeAddr represents the address of a named pipe.
type PipeConn ¶
type PipeConn struct {
// contains filtered or unexported fields
}
PipeConn is the implementation of the net.Conn interface for named pipe connections.
func Dial ¶
Dial connects to a named pipe with the given address. If the specified pipe is not available, it will wait indefinitely for the pipe to become available.
The address must be of the form \\.\\pipe\<name> for local pipes and \\<computer>\pipe\<name> for remote pipes.
Dial will return a PipeError if you pass in a badly formatted pipe name.
Examples:
// local pipe conn, err := Dial(`\\.\pipe\mypipename`) // remote pipe conn, err := Dial(`\\othercomp\pipe\mypipename`)
func DialTimeout ¶
DialTimeout acts like Dial, but will time out after the duration of timeout
func (*PipeConn) RemoteAddr ¶
RemoteAddr returns the remote network address.
func (*PipeConn) SetDeadline ¶
SetDeadline implements the net.Conn SetDeadline method. Note that timeouts are only supported on Windows Vista/Server 2008 and above
func (*PipeConn) SetReadDeadline ¶
SetReadDeadline implements the net.Conn SetReadDeadline method. Note that timeouts are only supported on Windows Vista/Server 2008 and above
func (*PipeConn) SetWriteDeadline ¶
SetWriteDeadline implements the net.Conn SetWriteDeadline method. Note that timeouts are only supported on Windows Vista/Server 2008 and above
type PipeError ¶
type PipeError struct {
// contains filtered or unexported fields
}
PipeError is an error related to a call to a pipe
type PipeListener ¶
type PipeListener struct {
// contains filtered or unexported fields
}
PipeListener is a named pipe listener. Clients should typically use variables of type net.Listener instead of assuming named pipe.
func Listen ¶
func Listen(address string) (*PipeListener, error)
Listen returns a new PipeListener that will listen on a pipe with the given address. The address must be of the form \\.\pipe\<name>
Listen will return a PipeError for an incorrectly formatted pipe name.
func (*PipeListener) Accept ¶
func (l *PipeListener) Accept() (net.Conn, error)
Accept implements the Accept method in the net.Listener interface; it waits for the next call and returns a generic net.Conn.
func (*PipeListener) AcceptPipe ¶
func (l *PipeListener) AcceptPipe() (*PipeConn, error)
AcceptPipe accepts the next incoming call and returns the new connection. It might return an error if a client connected and immediately cancelled the connection.
func (*PipeListener) Addr ¶
func (l *PipeListener) Addr() net.Addr
Addr returns the listener's network address, a PipeAddr.
func (*PipeListener) Close ¶
func (l *PipeListener) Close() error
Close stops listening on the address. Already Accepted connections are not closed.