mocks

package
v0.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 21, 2024 License: GPL-3.0 Imports: 6 Imported by: 0

Documentation

Overview

Package mocks is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MockMuxedStream

type MockMuxedStream struct {
	// contains filtered or unexported fields
}

MockMuxedStream is a mock of MuxedStream interface.

func NewMockMuxedStream

func NewMockMuxedStream(ctrl *gomock.Controller) *MockMuxedStream

NewMockMuxedStream creates a new mock instance.

func (*MockMuxedStream) Close

func (m *MockMuxedStream) Close() error

Close mocks base method.

func (*MockMuxedStream) CloseRead

func (m *MockMuxedStream) CloseRead() error

CloseRead mocks base method.

func (*MockMuxedStream) CloseWrite

func (m *MockMuxedStream) CloseWrite() error

CloseWrite mocks base method.

func (*MockMuxedStream) EXPECT

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMuxedStream) Read

func (m *MockMuxedStream) Read(p []byte) (int, error)

Read mocks base method.

func (*MockMuxedStream) Reset

func (m *MockMuxedStream) Reset() error

Reset mocks base method.

func (*MockMuxedStream) SetDeadline

func (m *MockMuxedStream) SetDeadline(arg0 time.Time) error

SetDeadline mocks base method.

func (*MockMuxedStream) SetReadDeadline

func (m *MockMuxedStream) SetReadDeadline(arg0 time.Time) error

SetReadDeadline mocks base method.

func (*MockMuxedStream) SetWriteDeadline

func (m *MockMuxedStream) SetWriteDeadline(arg0 time.Time) error

SetWriteDeadline mocks base method.

func (*MockMuxedStream) Write

func (m *MockMuxedStream) Write(p []byte) (int, error)

Write mocks base method.

type MockMuxedStreamMockRecorder

type MockMuxedStreamMockRecorder struct {
	// contains filtered or unexported fields
}

MockMuxedStreamMockRecorder is the mock recorder for MockMuxedStream.

func (*MockMuxedStreamMockRecorder) Close

Close indicates an expected call of Close.

func (*MockMuxedStreamMockRecorder) CloseRead

func (mr *MockMuxedStreamMockRecorder) CloseRead() *gomock.Call

CloseRead indicates an expected call of CloseRead.

func (*MockMuxedStreamMockRecorder) CloseWrite

func (mr *MockMuxedStreamMockRecorder) CloseWrite() *gomock.Call

CloseWrite indicates an expected call of CloseWrite.

func (*MockMuxedStreamMockRecorder) Read

func (mr *MockMuxedStreamMockRecorder) Read(p interface{}) *gomock.Call

Read indicates an expected call of Read.

func (*MockMuxedStreamMockRecorder) Reset

Reset indicates an expected call of Reset.

func (*MockMuxedStreamMockRecorder) SetDeadline

func (mr *MockMuxedStreamMockRecorder) SetDeadline(arg0 interface{}) *gomock.Call

SetDeadline indicates an expected call of SetDeadline.

func (*MockMuxedStreamMockRecorder) SetReadDeadline

func (mr *MockMuxedStreamMockRecorder) SetReadDeadline(arg0 interface{}) *gomock.Call

SetReadDeadline indicates an expected call of SetReadDeadline.

func (*MockMuxedStreamMockRecorder) SetWriteDeadline

func (mr *MockMuxedStreamMockRecorder) SetWriteDeadline(arg0 interface{}) *gomock.Call

SetWriteDeadline indicates an expected call of SetWriteDeadline.

func (*MockMuxedStreamMockRecorder) Write

func (mr *MockMuxedStreamMockRecorder) Write(p interface{}) *gomock.Call

Write indicates an expected call of Write.

type MockStream

type MockStream struct {
	// contains filtered or unexported fields
}

MockStream is a mock of Stream interface.

func NewMockStream

func NewMockStream(ctrl *gomock.Controller) *MockStream

NewMockStream creates a new mock instance.

func (*MockStream) Close

func (m *MockStream) Close() error

Close mocks base method.

func (*MockStream) CloseRead

func (m *MockStream) CloseRead() error

CloseRead mocks base method.

func (*MockStream) CloseWrite

func (m *MockStream) CloseWrite() error

CloseWrite mocks base method.

func (*MockStream) Conn

func (m *MockStream) Conn() network.Conn

Conn mocks base method.

func (*MockStream) EXPECT

func (m *MockStream) EXPECT() *MockStreamMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockStream) ID

func (m *MockStream) ID() string

ID mocks base method.

func (*MockStream) Protocol

func (m *MockStream) Protocol() protocol.ID

Protocol mocks base method.

func (*MockStream) Read

func (m *MockStream) Read(p []byte) (int, error)

Read mocks base method.

func (*MockStream) Reset

func (m *MockStream) Reset() error

Reset mocks base method.

func (*MockStream) Scope

func (m *MockStream) Scope() network.StreamScope

Scope mocks base method.

func (*MockStream) SetDeadline

func (m *MockStream) SetDeadline(arg0 time.Time) error

SetDeadline mocks base method.

func (*MockStream) SetProtocol

func (m *MockStream) SetProtocol(id protocol.ID) error

SetProtocol mocks base method.

func (*MockStream) SetReadDeadline

func (m *MockStream) SetReadDeadline(arg0 time.Time) error

SetReadDeadline mocks base method.

func (*MockStream) SetWriteDeadline

func (m *MockStream) SetWriteDeadline(arg0 time.Time) error

SetWriteDeadline mocks base method.

func (*MockStream) Stat

func (m *MockStream) Stat() network.Stats

Stat mocks base method.

func (*MockStream) Write

func (m *MockStream) Write(p []byte) (int, error)

Write mocks base method.

type MockStreamMockRecorder

type MockStreamMockRecorder struct {
	// contains filtered or unexported fields
}

MockStreamMockRecorder is the mock recorder for MockStream.

func (*MockStreamMockRecorder) Close

func (mr *MockStreamMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close.

func (*MockStreamMockRecorder) CloseRead

func (mr *MockStreamMockRecorder) CloseRead() *gomock.Call

CloseRead indicates an expected call of CloseRead.

func (*MockStreamMockRecorder) CloseWrite

func (mr *MockStreamMockRecorder) CloseWrite() *gomock.Call

CloseWrite indicates an expected call of CloseWrite.

func (*MockStreamMockRecorder) Conn

func (mr *MockStreamMockRecorder) Conn() *gomock.Call

Conn indicates an expected call of Conn.

func (*MockStreamMockRecorder) ID

ID indicates an expected call of ID.

func (*MockStreamMockRecorder) Protocol

func (mr *MockStreamMockRecorder) Protocol() *gomock.Call

Protocol indicates an expected call of Protocol.

func (*MockStreamMockRecorder) Read

func (mr *MockStreamMockRecorder) Read(p interface{}) *gomock.Call

Read indicates an expected call of Read.

func (*MockStreamMockRecorder) Reset

func (mr *MockStreamMockRecorder) Reset() *gomock.Call

Reset indicates an expected call of Reset.

func (*MockStreamMockRecorder) Scope

func (mr *MockStreamMockRecorder) Scope() *gomock.Call

Scope indicates an expected call of Scope.

func (*MockStreamMockRecorder) SetDeadline

func (mr *MockStreamMockRecorder) SetDeadline(arg0 interface{}) *gomock.Call

SetDeadline indicates an expected call of SetDeadline.

func (*MockStreamMockRecorder) SetProtocol

func (mr *MockStreamMockRecorder) SetProtocol(id interface{}) *gomock.Call

SetProtocol indicates an expected call of SetProtocol.

func (*MockStreamMockRecorder) SetReadDeadline

func (mr *MockStreamMockRecorder) SetReadDeadline(arg0 interface{}) *gomock.Call

SetReadDeadline indicates an expected call of SetReadDeadline.

func (*MockStreamMockRecorder) SetWriteDeadline

func (mr *MockStreamMockRecorder) SetWriteDeadline(arg0 interface{}) *gomock.Call

SetWriteDeadline indicates an expected call of SetWriteDeadline.

func (*MockStreamMockRecorder) Stat

func (mr *MockStreamMockRecorder) Stat() *gomock.Call

Stat indicates an expected call of Stat.

func (*MockStreamMockRecorder) Write

func (mr *MockStreamMockRecorder) Write(p interface{}) *gomock.Call

Write indicates an expected call of Write.

type MuxedStream

type MuxedStream interface {
	io.Reader
	io.Writer

	// Close closes the stream.
	//
	// * Any buffered data for writing will be flushed.
	// * Future reads will fail.
	// * Any in-progress reads/writes will be interrupted.
	//
	// Close may be asynchronous and _does not_ guarantee receipt of the
	// data.
	//
	// Close closes the stream for both reading and writing.
	// Close is equivalent to calling `CloseRead` and `CloseWrite`. Importantly, Close will not wait for any form of acknowledgment.
	// If acknowledgment is required, the caller must call `CloseWrite`, then wait on the stream for a response (or an EOF),
	// then call Close() to free the stream object.
	//
	// When done with a stream, the user must call either Close() or `Reset()` to discard the stream, even after calling `CloseRead` and/or `CloseWrite`.
	io.Closer

	// CloseWrite closes the stream for writing but leaves it open for
	// reading.
	//
	// CloseWrite does not free the stream, users must still call Close or
	// Reset.
	CloseWrite() error

	// CloseRead closes the stream for reading but leaves it open for
	// writing.
	//
	// When CloseRead is called, all in-progress Read calls are interrupted with a non-EOF error and
	// no further calls to Read will succeed.
	//
	// The handling of new incoming data on the stream after calling this function is implementation defined.
	//
	// CloseRead does not free the stream, users must still call Close or
	// Reset.
	CloseRead() error

	// Reset closes both ends of the stream. Use this to tell the remote
	// side to hang up and go away.
	Reset() error

	SetDeadline(time.Time) error
	SetReadDeadline(time.Time) error
	SetWriteDeadline(time.Time) error
}

type Stream

type Stream interface {
	MuxedStream

	// ID returns an identifier that uniquely identifies this Stream within this
	// host, during this run. Stream IDs may repeat across restarts.
	ID() string

	Protocol() protocol.ID
	SetProtocol(id protocol.ID) error

	// Stat returns metadata pertaining to this stream.
	Stat() network.Stats

	// Conn returns the connection this stream is part of.
	Conn() network.Conn

	// Scope returns the user's view of this stream's resource scope
	Scope() network.StreamScope
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL