director

Documentation

Overview

Copyright 2016-2019 DutchSec (https://dutchsec.com/)

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

http://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.

Copyright 2016-2019 DutchSec (https://dutchsec.com/)

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

http://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.

Copyright 2016-2019 DutchSec (https://dutchsec.com/)

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

http://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.

Index

• func ContainerClonedEvent(name, template string) event.Event
• func ContainerErrorEvent(name string, e error) event.Event
• func ContainerStartedEvent(name string) event.Event
• func ContainerUnfrozenEvent(name string, ip net.IP) event.Event
• func Get(key string) (func(...func(Director) error) (Director, error), bool)
• func GetAvailableDirectorNames() []string
• func Register(key string, fn func(...func(Director) error) (Director, error)) func(...func(Director) error) (Director, error)
• func WithChannel(channel pushers.Channel) func(Director) error
• func WithConfig(c toml.Primitive, decoder TomlDecoder) func(Director) error
• type Director
  • func Dummy(options ...func(Director) error) (Director, error)
  • func MustDummy(options ...func(Director) error) Director
• type SetChanneler
• type TomlDecoder

Functions

func ContainerClonedEvent

func ContainerClonedEvent(name, template string) event.Event

ContainerClonedEvent returns a connection open event object giving the associated data values.

func ContainerErrorEvent

func ContainerErrorEvent(name string, e error) event.Event

ContainerErrorEvent returns a connection open event object giving the associated data values.

func ContainerStartedEvent

func ContainerStartedEvent(name string) event.Event

ContainerStartedEvent returns a connection open event object giving the associated data values.

func ContainerUnfrozenEvent

func ContainerUnfrozenEvent(name string, ip net.IP) event.Event

ContainerUnfrozenEvent returns a connection open event object giving the associated data values.

func Get

func Get(key string) (func(...func(Director) error) (Director, error), bool)

func GetAvailableDirectorNames

func GetAvailableDirectorNames() []string

func Register

func Register(key string, fn func(...func(Director) error) (Director, error)) func(...func(Director) error) (Director, error)

func WithChannel

func WithChannel(channel pushers.Channel) func(Director) error

func WithConfig

func WithConfig(c toml.Primitive, decoder TomlDecoder) func(Director) error

Types

type Director

type Director interface {
	Dial(net.Conn) (net.Conn, error)
}

Director defines an interface which exposes an interface to allow structures that implement this interface allow us to control containers which they provide.

func Dummy

func Dummy(options ...func(Director) error) (Director, error)

func MustDummy

func MustDummy(options ...func(Director) error) Director

type SetChanneler

type SetChanneler interface {
	SetChannel(pushers.Channel)
}

type TomlDecoder

type TomlDecoder interface {
	PrimitiveDecode(primValue toml.Primitive, v interface{}) error
}