restserver

Documentation

Index

• Constants
• func ReturnCodeToString(returnCode int) (s string)
• type HTTPRestService
  • func (service *HTTPRestService) GetPartitionKey() (dncPartitionKey string)
  • func (service *HTTPRestService) SendNCSnapShotPeriodically(ncSnapshotIntervalInMinutes int, stopSnapshot chan bool)
  • func (service *HTTPRestService) Start(config *common.ServiceConfig) error
  • func (service *HTTPRestService) Stop()
• type HTTPService
  • func NewHTTPRestService(config *common.ServiceConfig) (HTTPService, error)

Constants

const (
	Success                         = 0
	UnsupportedNetworkType          = 1
	InvalidParameter                = 2
	UnsupportedEnvironment          = 3
	UnreachableHost                 = 4
	ReservationNotFound             = 5
	MalformedSubnet                 = 8
	UnreachableDockerDaemon         = 9
	UnspecifiedNetworkName          = 10
	NotFound                        = 14
	AddressUnavailable              = 15
	NetworkContainerNotSpecified    = 16
	CallToHostFailed                = 17
	UnknownContainerID              = 18
	UnsupportedOrchestratorType     = 19
	DockerContainerNotSpecified     = 20
	UnsupportedVerb                 = 21
	UnsupportedNetworkContainerType = 22
	InvalidRequest                  = 23
	NetworkJoinFailed               = 24
	NetworkContainerPublishFailed   = 25
	NetworkContainerUnpublishFailed = 26
	UnexpectedError                 = 99
)

Container Network Service remote API Contract.

Functions

func ReturnCodeToString

func ReturnCodeToString(returnCode int) (s string)

ReturnCodeToString - Converts an error code to appropriate string.

Types

type HTTPRestService

type HTTPRestService struct {
	*cns.Service
	// contains filtered or unexported fields
}

HTTPRestService represents http listener for CNS - Container Networking Service.

func (*HTTPRestService) GetPartitionKey

func (service *HTTPRestService) GetPartitionKey() (dncPartitionKey string)

GetPartitionKey - Get dnc/service partition key

func (*HTTPRestService) SendNCSnapShotPeriodically

func (service *HTTPRestService) SendNCSnapShotPeriodically(ncSnapshotIntervalInMinutes int, stopSnapshot chan bool)

Sets up periodic timer for sending network container snapshots

func (*HTTPRestService) Start

func (service *HTTPRestService) Start(config *common.ServiceConfig) error

Start starts the CNS listener.

func (*HTTPRestService) Stop

func (service *HTTPRestService) Stop()

Stop stops the CNS.

type HTTPService

type HTTPService interface {
	common.ServiceAPI
	SendNCSnapShotPeriodically(int, chan bool)
}

HTTPService describes the min API interface that every service should have.

func NewHTTPRestService

func NewHTTPRestService(config *common.ServiceConfig) (HTTPService, error)

NewHTTPRestService creates a new HTTP Service object.