package
4.5.8+incompatible
Repository: https://github.com/opencord/voltha-openolt-adapter.git
Documentation: pkg.go.dev

# Functions

BuildPortObject allows for updating north and southbound ports, newly discovered ports, and devices.
FlowStatisticsIndication to be implemented.
GetportLabel returns the label for the NNI and the PON port based on port number and port type.
InitPorts collects the port objects: nni and pon that are updated with the current data from the OLT.
NewDeviceHandler creates a new device handler.
NewEventMgr is a Function to get a new event manager struct for the OpenOLT to process and publish OpenOLT event.
NewFlowManager creates OpenOltFlowMgr object and initializes the parameters.
NewGroupManager creates OpenOltGroupMgr object and initializes the parameters.
NewNniPort returns a new instance of NniPort initialized with the given PortNum and IntfID.
NewOnuDevice creates a new Onu Device.
NewOpenOLT returns a new instance of OpenOLT.
NewOpenOLTInterAdapter returns a new instance of OpenOLTInterAdapter.
NewOpenOltStatsMgr returns a new instance of the OpenOltStatisticsMgr.
NewPONPort returns a new instance of PonPort initialized with given PONID, DeviceID, IntfID and PortNum.
NewTransitionMap create a new state machine with all the transitions.
SetKVClient sets the KV client and return a kv backend.

# Constants

AllocID constant.
BerReported constant.
BipErrors constant.
BipUnits constant.
ContextDeviceID is for the device id in the context of the event.
ContextOltAdminState is for the admin state of the Olt in the context of the event.
ContextOltConnectState is for the connect state of the Olt in the context of the event.
ContextOltFailureReason is to report the reason of an operation failure in the Olt.
ContextOltFirmwareVersion is for the Olt firmware version in the context of the event.
ContextOltHardwareVersion is for the Olt hardware version in the context of the event.
ContextOltMacAddress is for the OLT mac address.
ContextOltOperState is for the operational state of the Olt in the context of the event.
ContextOltParentID is for the Olt parent id in the context of the event.
ContextOltParentPortNo is for the Olt parent port no in the context of the event.
ContextOltPonIntfID is for the PON interface Id on an OLT event.
ContextOltPonIntfOperState is for the operational state of a PON port in the context of an OLT event.
ContextOltPonTechnology is to indicate the pon-technology type, ie, 'GPON' or 'XGS-PON' (TODO check for combo?).
ContextOltPortLabel is to indicate the string label of the pon-port, example: pon-0.
ContextOltSerialNumber is for the serial number of the OLT.
ContextOltType is for the Olt type in the context of the event.
ContextOltVendor is for the Olt vendor in the context of the event.
ContextOnuDelineationErrors is for the delineation errors if present in an ONU events context.
ContextOnuDeviceID is for the device id of the ONU generated by VOLTHA.
ContextOnuDifferentialDistance is for the differential distance in an ONU event context.
ContextOnuDrift is for the drift of an ONU in the context of an event.
ContextOnuFailureReaseon is for the reason of failure of/at ONU indicated by the event.
ContextOnuInverseBitErrorRate is for the inverse bit error rate in the context of an ONU event.
ContextOnuNewEqd is for the New Eqd of an ONU in the context of an event.
ContextOnuOnuID is for the Onu Id in the context of the event.
ContextOnuPonIntfID is for the PON interface Id on which the Onu Event occurred.
ContextOnuRemoteDefectIndicatorCount is for the rdi in the context of an ONU event.
ContextOnuSerialNumber is for the serial number of the ONU.
DefaultMgmtVlan default vlan value.
DelimiterMissDetection constant.
DeviceDownInd Go to Device down state.
DeviceInit Go to Device init state.
DeviceUpInd Go to Device up state.
DoubleTag constant.
Downstream constant.
EapEthType eapethtype value.
EthDst constant.
EthSrc constant.
EthType constant.
FecCodewords constant.
FecCodewordsCorrected constant.
FecCorrectedSymbols constant.
FecCorrectedUnits constant.
GemID constant.
GEMStats statType constant.
GroupID constant.
GrpcConnected Go to connected state.
GrpcDisconnected Go to Device init state.
IgmpProto proto value.
InPort constant.
IntfID constant.
Constants for number of retries and for timeout.
IPProto constant.
IPProtoDhcp flow category.
Ipv4Dst constant.
IPv4EthType IPv4 ethernet type value.
Ipv4Src constant.
LcdgErrors constant.
LldpEthType lldp ethtype value.
MaxMeterBand constant.
Constants for number of retries and for timeout.
Constants for number of retries and for timeout.
Constants for number of retries and for timeout.
Constants for number of retries and for timeout.
Metadata constant.
Multicast constant.
NegativeDrift constant.
NNIStats statType constant.
NoneOnuID constant.
NoneUniID constant.
OnuID constant.
ONUStats statType constant.
Output constant.
PacketTagType constant.
PONStats statType constant.
PopVlan constant.
PortNo constant.
PositiveDrift constant.
PPPoEDEthType PPPoE discovery ethernet type value.
PushVlan constant.
RdiErrors constant.
ReservedVlan Transparent Vlan (Masked Vlan, VLAN_ANY in ONOS Flows).
RxBytes constant.
RxOmci constant.
RxOmciPacketsCrcError constant.
RxPackets constant.
RxPloamsError constant.
RxPloamsNonIdle constant.
SingleTag constant.
Timestamp constant.
TPID constant.
TrapToHost constant.
TunnelID constant.
TxBytes constant.
TxPackets constant.
UDPDst constant.
UDPSrc constant.
UniID constant.
Untagged constant.
Upstream constant.
VlanPcp constant.
VlanPCPMask contant.
VlanVid constant.
VlanvIDMask constant.
XGEMKeyErrors constant.
XGEMLoss constant.

# Structs

DeviceHandler will interact with the OLT device.
McastFlowOrGroupControlBlock is created per mcast flow/group add/modify/remove and pushed on the incomingMcastFlowOrGroup channel slice The McastFlowOrGroupControlBlock is then picked by the mcastFlowOrGroupChannelHandlerRoutine for further processing.
NniPort representation.
OnuDevice represents ONU related info.
OpenOLT structure holds the OLT information.
OpenOltEventMgr struct contains.
OpenOltFlowMgr creates the Structure of OpenOltFlowMgr obj.
OpenOltGroupMgr creates the Structure of OpenOltGroupMgr obj.
OpenOLTInterAdapter structure holds a reference to the oltAdapter.
OpenOltStatisticsMgr structure.
PonPort representation.
QueueInfoBrief has information about gemPortID and service priority associated with Mcast group.
Transition to store state machine.
TransitionMap to store all the states and current device state.

# Type aliases

DeviceState OLT Device state.
StatType defines portStatsType and flowStatsType types.
TransitionHandler function type for handling transition.
Trigger for changing the state.