package buffer

Import Path
	google.golang.org/grpc/internal/buffer (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	   #d unbounded.go
		Package buffer provides an implementation of an unbounded buffer.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Unbounded (struct)
		Unbounded is an implementation of an unbounded buffer which does not use
		extra goroutines. This is typically used for passing updates from one entity
		to another within gRPC.

		All methods on this type are thread-safe and don't block on anything except
		the underlying mutex used for synchronization.

		Unbounded supports values of any type to be stored in it by using a channel
		of `interface{}`. This means that a call to Put() incurs an extra memory
		allocation, and also that users need a type assertion while reading. For
		performance critical code paths, using Unbounded is strongly discouraged and
		defining a new type specific implementation of this buffer is preferred. See
		internal/transport/transport.go for an example of this.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			backlog []interface{}
			c chan interface{}
			mu sync.Mutex
		Methods (total 3, all are exported)
			(*Unbounded) Get() <-chan interface{}
				Get returns a read channel on which values added to the buffer, via Put(),
				are sent on.

				Upon reading a value from this channel, users are expected to call Load() to
				send the next buffered value onto the channel if there is any.

			(*Unbounded) Load()
				Load sends the earliest buffered data, if any, onto the read channel
				returned by Get(). Users are expected to call this every time they read a
				value from the read channel.

			(*Unbounded) Put(t interface{})
				Put adds t to the unbounded buffer.

		As Outputs Of (at least one exported)
			func NewUnbounded() *Unbounded


Package-Level Functions (only one, which is exported)

	 func NewUnbounded() *Unbounded
		NewUnbounded returns a new instance of Unbounded.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)