mirror of
https://github.com/openziti/ziti.git
synced 2026-09-23 19:06:38 +00:00
Andrew Martinez
78 lines
3.3 KiB
Go
78 lines
3.3 KiB
Go
/*
|
|
Copyright NetFoundry, Inc.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package env
|
|
|
|
import (
|
|
"github.com/openziti/edge/controller/model"
|
|
"github.com/openziti/edge/controller/persistence"
|
|
"github.com/openziti/fabric/controller/network"
|
|
)
|
|
|
|
// Aliased type for router strategies
|
|
type RouterSyncStrategyType string
|
|
|
|
// Aliased type for router sync status
|
|
type RouterSyncStatus string
|
|
|
|
const (
|
|
RouterSyncNew RouterSyncStatus = "SYNC_NEW" //connection accepted but no strategy actions have been taken
|
|
RouterSyncQueued RouterSyncStatus = "SYNC_QUEUED" //connection handed to strategy, but not processed
|
|
RouterSyncHello RouterSyncStatus = "SYNC_HELLO" //connection is beginning hello cycle
|
|
RouterSyncHelloWait RouterSyncStatus = "SYNC_HELLO_WAIT" //hello received from router, but there are too many synchronizing routers
|
|
RouterSyncResyncWait RouterSyncStatus = "SYNC_RESYNC_WAIT" //router requested a resync, in queue
|
|
RouterSynInProgress RouterSyncStatus = "SYNC_IN_PROGRESS" //hello finished, starting to send state
|
|
RouterSyncDone RouterSyncStatus = "SYNC_DONE" //initial state sent
|
|
|
|
//Error states
|
|
RouterSyncUnknown RouterSyncStatus = "SYNC_UNKNOWN" //the router is currently unknown
|
|
RouterSyncDisconnected RouterSyncStatus = "SYNC_DISCONNECTED" //strategy was disconnected before finishing
|
|
RouterSyncHelloTimeout RouterSyncStatus = "SYNC_HELLO_TIMEOUT" //sync failed due to a hello timeout.
|
|
RouterSyncError RouterSyncStatus = "SYNC_ERROR" //sync failed due to an unexpected error
|
|
|
|
//msg headers
|
|
SyncStrategyTypeHeader = 1013
|
|
SyncStrategyStateHeader = 1014
|
|
)
|
|
|
|
// RouterSyncStrategy handles the life cycle of an Edge Router connecting to the controller, synchronizing
|
|
// any upfront state and then maintaining state after that.
|
|
type RouterSyncStrategy interface {
|
|
Type() RouterSyncStrategyType
|
|
Status(id string) RouterSyncStatus
|
|
GetOnlineEdgeRouter(id string) (*model.EdgeRouter, RouterSyncStatus)
|
|
Stop()
|
|
RouterConnectionHandler
|
|
RouterSynchronizerEventHandler
|
|
}
|
|
|
|
// RouterConnectionHandler is responsible for handling router connect/disconnect for synchronizing state.
|
|
// This is intended for API Session but additional state is possible. Implementations may bind additional
|
|
// handlers to the channel.
|
|
type RouterConnectionHandler interface {
|
|
RouterConnected(edgeRouter *model.EdgeRouter, router *network.Router)
|
|
RouterDisconnected(router *network.Router)
|
|
}
|
|
|
|
// RouterSynchronizerEventHandler is responsible for keeping Edge Routers up to date on API Sessions
|
|
type RouterSynchronizerEventHandler interface {
|
|
ApiSessionAdded(apiSession *persistence.ApiSession)
|
|
ApiSessionUpdated(apiSession *persistence.ApiSession, apiSessionCert *persistence.ApiSessionCertificate)
|
|
ApiSessionDeleted(apiSession *persistence.ApiSession)
|
|
|
|
SessionDeleted(session *persistence.Session)
|
|
}
|