antelope_ship_client

Nov 2, 2024

Changes in this version

type Stream

+ MaxMessagesInFlight uint32

Jun 19, 2023

Changes in this version

+ var ErrEndBlockReached = errors.New("ship: end block reached")

May 10, 2023

Changes in this version

type Option

+ func WithTraces() Option

Apr 26, 2023

Changes in this version

type Option

+ func WithTableDeltaHandler(value TableDeltaFn) Option

type Stream

+ TableDeltaHandler TableDeltaFn

+ type TableDeltaFn func([]*ship.TableDeltaV0)

Feb 15, 2023

Changes in this version

+ type Stream struct

+ BlockHandler BlockFn

+ CloseHandler CloseFn

+ ConnectTimeout time.Duration

+ EndBlock uint32

+ InitHandler InitFn

+ IrreversibleOnly bool

+ ShutdownTimeout time.Duration

+ StartBlock uint32

+ StatusHandler StatusFn

+ TraceHandler TraceFn

+ func NewStream(options ...Option) *Stream

+ func (s *Stream) Connect(url string) error

+ func (s *Stream) ConnectContext(ctx context.Context, url string) error

+ func (s *Stream) Run() error

+ func (s *Stream) SendBlocksRequest() error

+ func (s *Stream) SendStatusRequest() error

+ func (s *Stream) Shutdown() error

Feb 2, 2023

Changes in this version

+ const ErrSendACK

type Client

+ ConnectTimeout time.Duration

+ ShutdownTimeout time.Duration

+ func (c *Client) ConnectContext(ctx context.Context, url string) error

+ func (c *Client) Recv() (int, []byte, error)

+ func (c *Client) Shutdown() error

+ type ClientError struct

+ Text string

+ Type int

+ func (e ClientError) Error() string

type Option

+ func WithConnectTimeout(value time.Duration) Option

+ func WithShutdownTimeout(value time.Duration) Option

Jan 17, 2023

Changes in this version

+ type BlockFn func(*ship.GetBlocksResultV0)

+ type Client struct

+ BlockHandler BlockFn

+ CloseHandler CloseFn

+ EndBlock uint32

+ InitHandler InitFn

+ IrreversibleOnly bool

+ MaxMessagesInFlight uint32

+ StartBlock uint32

+ StatusHandler StatusFn

+ TraceHandler TraceFn

+ func (c *Client) Close() error

+ func (c *Client) Connect(host string) error

+ func (c *Client) ConnectURL(url url.URL) error

+ func (c *Client) IsOpen() bool

+ func (c *Client) Read() error

+ func (c *Client) ReadRaw() (int, []byte, error)

+ func (c *Client) SendACK() error

+ func (c *Client) SendBlocksRequest() error

+ func (c *Client) SendCloseMessage() error

+ func (c *Client) SendStatusRequest() error

+ func (c Client) UnconfirmedMessages() uint32

+ type CloseFn func()

+ type InitFn func(*eos.ABI)

+ type Option func(*Client)

+ func WithBlockHandler(value BlockFn) Option

+ func WithCloseHandler(value CloseFn) Option

+ func WithEndBlock(value uint32) Option

+ func WithInitHandler(value InitFn) Option

+ func WithIrreversibleOnly(value bool) Option

+ func WithMaxMessagesInFlight(value uint32) Option

+ func WithStartBlock(value uint32) Option

+ func WithStatusHandler(value StatusFn) Option

+ func WithTraceHandler(value TraceFn) Option

+ type StatusFn func(*ship.GetStatusResultV0)

+ type TraceFn func([]*ship.TransactionTraceV0)

Nov 30, 2022

Changes in this version

+ const ErrACK

+ const ErrNotConnected

+ const ErrParse

+ const ErrSendClose

+ const ErrSockClosed

+ const ErrSockRead

+ const NULL_BLOCK_NUMBER

+ type ShipClient struct

+ BlockHandler func(*ship.GetBlocksResultV0)

+ CloseHandler func()

+ EndBlock uint32

+ InitHandler func(*eos.ABI)

+ IrreversibleOnly bool

+ MaxMessagesInFlight uint32

+ StartBlock uint32

+ StatusHandler func(*ship.GetStatusResultV0)

+ TraceHandler func([]*ship.TransactionTraceV0)

+ func NewClient(startBlock uint32, endBlock uint32, irreversibleOnly bool) *ShipClient

+ func (c *ShipClient) Close() error

+ func (c *ShipClient) Connect(host string) error

+ func (c *ShipClient) ConnectURL(url url.URL) error

+ func (c *ShipClient) IsOpen() bool

+ func (c *ShipClient) Read() error

+ func (c *ShipClient) ReadRaw() (int, []byte, error)

+ func (c *ShipClient) SendACK() error

+ func (c *ShipClient) SendBlocksRequest() error

+ func (c *ShipClient) SendCloseMessage() error

+ func (c *ShipClient) SendStatusRequest() error

+ func (c ShipClient) UnconfirmedMessages() uint32

+ type ShipClientError struct

+ Text string

+ Type int

+ func (e ShipClientError) Error() string