blob: 61b5c1b61aa434a660a2398badc48f08f6ac002d [file] [log] [blame]
David Bainbridgef8ce7d22020-04-08 12:49:41 -07001/*
Joey Armstrong03b20872024-01-12 13:03:07 -05002 * Copyright 2020-2024 Open Networking Foundation (ONF) and the ONF Contributors
David Bainbridgef8ce7d22020-04-08 12:49:41 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17// The implementation of the open flow agent (ofagent) uses a GRPC connection
18// to VOLTHA accross several implementaton packages including the ofagent and
19// openflow packages. This GRPC connection is shared through packages and type
20// instances via injection.
21//
22// As the ofagent executes within a micro-service environment it is
23// possible that the GRPC connection is reset (re-established). When the connection
24// is re-established, because injection is used, the new value needs to be
25// re-injected across the implementation.
26//
27// To help simply the re-injection or value change scenario a holder for the
28// GRPC connection is established so that the reference to the holder can
29// stay [sic] consistant over the lifetime of the ofagent while the underlying
30// GRPC connection can change without walking the entire runtime structure.
31package holder