README
¶
The ranch.
Welcome to the ranch.
I designed this architecture over many years, it was born inside a company, who doesn't care about it. So the code has been forked and now lives here. She has great power, yet to be tapped into correctly.
We're going to change all that.
Originally a tool called the Bifrost and then re-named to transport and now, simply, we call her.
The Ranch
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bridge contains all things bridge / broker connector
|
Package bridge contains all things bridge / broker connector |
|
Package bus contains all things bus.
|
Package bus contains all things bus. |
|
tx
Package tx provides transactional request orchestration on top of the event bus.
|
Package tx provides transactional request orchestration on top of the event bus. |
|
Package model defines the request, response, and message payload types shared by Ranch transports and services.
|
Package model defines the request, response, and message payload types shared by Ranch transports and services. |
|
Package monitor defines shared monitor event names without coupling peer packages.
|
Package monitor defines shared monitor event names without coupling peer packages. |
|
plank
|
|
|
pkg/middleware
Package middleware contains HTTP middleware used by the Plank server.
|
Package middleware contains HTTP middleware used by the Plank server. |
|
pkg/ratelimit
Package ratelimit provides tiered HTTP rate limiting middleware.
|
Package ratelimit provides tiered HTTP rate limiting middleware. |
|
pkg/routing
Package routing provides a small route registry backed by net/http ServeMux matching.
|
Package routing provides a small route registry backed by net/http ServeMux matching. |
|
pkg/server
Package server wires Plank HTTP, Fabric, service, and store components into a runnable platform server.
|
Package server wires Plank HTTP, Fabric, service, and store components into a runnable platform server. |
|
services
Package services contains example Plank services used by demos and tests.
|
Package services contains example Plank services used by demos and tests. |
|
utils
Package utils contains small helpers shared by Plank packages.
|
Package utils contains small helpers shared by Plank packages. |
|
Package service defines Fabric service contracts, lifecycle hooks, and REST bridge support.
|
Package service defines Fabric service contracts, lifecycle hooks, and REST bridge support. |
|
Package stompserver implements the in-process STOMP server used by the Fabric transport.
|
Package stompserver implements the in-process STOMP server used by the Fabric transport. |
|
Package store provides observable in-memory stores and optional cross-broker synchronization.
|
Package store provides observable in-memory stores and optional cross-broker synchronization. |
|
transport
|
|
|
fabric
Package fabric exposes the STOMP-backed Fabric endpoint that bridges external clients to the event bus.
|
Package fabric exposes the STOMP-backed Fabric endpoint that bridges external clients to the event bus. |
Click to show internal directories.
Click to hide internal directories.