-
Notifications
You must be signed in to change notification settings - Fork 156
/
device.go
68 lines (58 loc) · 2.68 KB
/
device.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright 2021 Anapaya Systems
//
// 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.
package control
import (
"context"
"io"
"github.com/scionproto/scion/pkg/addr"
"github.com/scionproto/scion/pkg/private/serrors"
)
// DeviceOpener can be used to open readable/writeable objects that support
// IPv4/IPv6 routing. Typically, this is a Linux network device.
type DeviceOpener interface {
Open(ctx context.Context, ia addr.IA) (Device, error)
}
// Device models an object that implements the reading and writing of packets and supports
// the addition of IPv4 and IPv6 routes through it. To destroy the interface, call Close. Calling
// Close multiple times should result in an error.
type Device interface {
io.ReadWriteCloser
// AddRoute creates a route going through the device.
AddRoute(ctx context.Context, r *Route) error
// DeleteRoute destroys a route going through the device.
DeleteRoute(ctx context.Context, r *Route) error
}
// DeviceOpenerFunc is a function type that implements DeviceOpener.
type DeviceOpenerFunc func(ctx context.Context, ia addr.IA) (Device, error)
func (f DeviceOpenerFunc) Open(ctx context.Context, ia addr.IA) (Device, error) {
return f(ctx, ia)
}
var (
// ObjectDestroyedError is returned by DeviceHandle API calls if the handle has been closed
// before or during the API call. If the device is closed while the API call is ongoing, it is
// not guaranteed that the returned error is ObjectDestroyedError, because the device access
// might have completed before the close, but the API call hasn't finished yet.
ObjectDestroyedError = serrors.New("object was destroyed")
)
// DeviceHandle implements reference counting for a Device. Close should be called once
// for each time the DeviceHandle was obtained from a DeviceManager.
type DeviceHandle Device
// DeviceManager returns handles to shared device objects. If an error is returned, no resource
// has been created.
type DeviceManager interface {
// Get returns a DeviceHandle to a Device created by the DeviceManager. The reference
// count of the handle is increased the 1. To ensure resources are not leaked,
// each DeviceHandle should be closed after use.
Get(ctx context.Context, ia addr.IA) (DeviceHandle, error)
}