types

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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

• Constants
• Variables
• func IsUseOfClosedNetConnErr(err error) bool
• type Event
• type EventType
  • func (ev EventType) IsAddEvent() bool
  • func (ev EventType) IsSyncEvent() bool
  • func (ev EventType) String() string
• type Labels
  • func (s Labels) IsSubsetOf(f Labels) bool
• type MultiValueLabels
  • func (s MultiValueLabels) BuildQuery() []string
  • func (s MultiValueLabels) IsSubsetOf(f Labels) bool
• type PodCache
  • func NewPodCache() PodCache
• type TimeDuration
  • func (d *TimeDuration) MarshalJSON() ([]byte, error)
  • func (d *TimeDuration) MarshalYAML() (interface{}, error)
  • func (d *TimeDuration) UnmarshalJSON(data []byte) error
  • func (d *TimeDuration) UnmarshalYAML(unmarshal func(interface{}) error) error

Constants

const (
	// EventAdd means an add event.
	EventAdd = iota + 1
	// EventUpdate means an update event.
	EventUpdate
	// EventDelete means a delete event.
	EventDelete
	// EventSync triggers by periodic synchronization, should make a comparison before any request to APISIX
	// The synchronization considered as add event,
	// so its behavior should be the same as EventAdd in controller
	EventSync
)

Variables

var (
	// ErrPodNoAssignedIP represents that PodCache operation is failed due to the
	// target Pod is not in Running phase.
	ErrPodNoAssignedIP = errors.New("pod not running")
	// ErrPodNotFound represents that the target pod not found from the PodCache.
	ErrPodNotFound = errors.New("pod not found")
)

var (
	ResolveGranularity = struct {
		Endpoint string
		Service  string
	}{
		Endpoint: "endpoint",
		Service:  "service",
	}
)

Functions

func IsUseOfClosedNetConnErr

func IsUseOfClosedNetConnErr(err error) bool

IsUseOfClosedNetConnErr checks whether the error is due to use of closed network connection.

Types

type Event

type Event struct {
	// Type is the type of event.
	Type EventType
	// Object is the event subject.
	Object interface{}
	// OldObject is the old object in update event.
	OldObject interface{}
	// Tombstone is the final state before object was delete,
	// it's useful for DELETE event.
	Tombstone interface{}
}

Event represents a typed event.

type EventType

type EventType int

EventType is the type of event.

func (EventType) IsAddEvent

func (ev EventType) IsAddEvent() bool

func (EventType) IsSyncEvent

func (ev EventType) IsSyncEvent() bool

func (EventType) String

func (ev EventType) String() string

type Labels

type Labels map[string]string

Labels contains a series of labels.

func (Labels) IsSubsetOf

func (s Labels) IsSubsetOf(f Labels) bool

IsSubsetOf checks whether the current Labels is the subset of the passed Labels.

type MultiValueLabels

type MultiValueLabels map[string][]string

MultiValueLabels contains a series of labels with multiple values.

func (MultiValueLabels) BuildQuery

func (s MultiValueLabels) BuildQuery() []string

func (MultiValueLabels) IsSubsetOf

func (s MultiValueLabels) IsSubsetOf(f Labels) bool

IsSubsetOf checks whether the current Labels is the subset of the passed Labels.

type PodCache

type PodCache interface {
	// Add adds a pod to cache, only pod which state is RUNNING will be
	// accepted.
	Add(*corev1.Pod) error
	// Delete deletes a pod from the cache
	Delete(*corev1.Pod) error
	// GetNameByIP returns the pod name according to the given pod IP.
	GetNameByIP(string) (string, error)
}

PodCache caches pod. Currently, it doesn't cache the pod object but only its name.

func NewPodCache

func NewPodCache() PodCache

NewPodCache creates a PodCache object.

type TimeDuration

type TimeDuration struct {
	time.Duration `json:",inline"`
}

TimeDuration is yet another time.Duration but implements json.Unmarshaler and json.Marshaler, yaml.Unmarshaler and yaml.Marshaler interfaces so one can use "1h", "5s" and etc in their json/yaml configurations.

Note the format to represent time is same as time.Duration. See the comments about time.ParseDuration for more details.

func (*TimeDuration) MarshalJSON

func (d *TimeDuration) MarshalJSON() ([]byte, error)

func (*TimeDuration) MarshalYAML

func (d *TimeDuration) MarshalYAML() (interface{}, error)

func (*TimeDuration) UnmarshalJSON

func (d *TimeDuration) UnmarshalJSON(data []byte) error

func (*TimeDuration) UnmarshalYAML

func (d *TimeDuration) UnmarshalYAML(unmarshal func(interface{}) error) error