Documentation
¶
Overview ¶
Package fossilizer defines types to implement a fossilizer.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Adapter ¶
type Adapter interface {
// Returns arbitrary information about the adapter.
GetInfo(context.Context) (interface{}, error)
// Adds a channel that receives events from the fossilizer
AddFossilizerEventChan(chan *Event)
// Requests data to be fossilized.
// Meta is arbitrary data that will be forwarded to the websocket.
Fossilize(ctx context.Context, data []byte, meta []byte) error
}
Adapter must be implemented by a fossilier.
type Event ¶ added in v0.2.0
type Event struct {
EventType EventType
Data interface{}
}
Event is the object fossilizers send to notify of important events.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package fossilizerhttp is used to create an HTTP server from a fossilizer adapter.
|
Package fossilizerhttp is used to create an HTTP server from a fossilizer adapter. |
|
Package fossilizertesting defines helpers to test fossilizers.
|
Package fossilizertesting defines helpers to test fossilizers. |
Click to show internal directories.
Click to hide internal directories.