code.vegaprotocol.io/vega@v0.79.0/libs/broker/subscriber.go (about)

     1  // Copyright (C) 2023 Gobalsky Labs Limited
     2  //
     3  // This program is free software: you can redistribute it and/or modify
     4  // it under the terms of the GNU Affero General Public License as
     5  // published by the Free Software Foundation, either version 3 of the
     6  // License, or (at your option) any later version.
     7  //
     8  // This program is distributed in the hope that it will be useful,
     9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    11  // GNU Affero General Public License for more details.
    12  //
    13  // You should have received a copy of the GNU Affero General Public License
    14  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    15  
    16  package broker
    17  
    18  import "code.vegaprotocol.io/vega/core/events"
    19  
    20  //go:generate go run github.com/golang/mock/mockgen -destination mocks/mocks.go -package mocks code.vegaprotocol.io/vega/libs/broker Subscriber
    21  
    22  // Subscriber interface allows pushing values to subscribers, can be set to
    23  // a Skip state (temporarily not receiving any events), or closed. Otherwise events are pushed.
    24  type Subscriber interface {
    25  	Push(val ...events.Event)
    26  	Skip() <-chan struct{}
    27  	Closed() <-chan struct{}
    28  	C() chan<- []events.Event
    29  	Types() []events.Type
    30  	SetID(id int)
    31  	ID() int
    32  	Ack() bool
    33  }