Uses of Class
org.onosproject.net.DeviceId

Packages that use DeviceId

Package	Description
org.onosproject.mastership	Set of abstractions for dealing with controller mastership related topics.
org.onosproject.net	Network model entities & service API definitions.
org.onosproject.net.device	Infrastructure device model & related services API definitions.
org.onosproject.net.flow	Flow rule model & related services API definitions.
org.onosproject.net.host	End-station host model & related services API definitions.
org.onosproject.net.intent.constraint	Definitions of constraints used to refine intent specifications.
org.onosproject.net.link	Infrastructure link model & related services API definitions.
org.onosproject.net.packet	Mechanism for processing inbound packets intercepted from the data plane and for emitting outbound packets onto the data plane.
org.onosproject.net.provider	Base abstractions related to network entity providers and their brokers.
org.onosproject.net.topology	Network topology model & related services API definitions.

Uses of DeviceId in org.onosproject.mastership

Methods in org.onosproject.mastership that return types with arguments of type DeviceId

Modifier and Type	Method and Description
Set<DeviceId>	MastershipStore.getDevices(NodeId nodeId) Returns the devices that a controller instance is master of.
Set<DeviceId>	MastershipService.getDevicesOf(NodeId nodeId) Returns the devices for which a controller is master.

Methods in org.onosproject.mastership with parameters of type DeviceId

Modifier and Type	Method and Description
MastershipRole	MastershipService.getLocalRole(DeviceId deviceId) Returns the role of the local node for the specified device, without triggering master selection.
NodeId	MastershipStore.getMaster(DeviceId deviceId) Returns the master for a device.
NodeId	MastershipService.getMasterFor(DeviceId deviceId) Returns the current master for a given device.
MastershipTerm	MastershipTermService.getMastershipTerm(DeviceId deviceId) Returns the term number of mastership change occurred for given device.
RoleInfo	MastershipStore.getNodes(DeviceId deviceId) Returns the master and backup nodes for a device.
RoleInfo	MastershipService.getNodesFor(DeviceId deviceId) Returns controllers connected to a given device, in order of preference.
MastershipRole	MastershipStore.getRole(NodeId nodeId, DeviceId deviceId) Returns the role of a device for a specific controller instance.
MastershipTerm	MastershipStore.getTermFor(DeviceId deviceId) Returns the current master and number of past mastership hand-offs (terms) for a device.
void	MastershipService.relinquishMastership(DeviceId deviceId) Abandons mastership of the specified device on the local node thus forcing selection of a new master.
MastershipEvent	MastershipStore.relinquishRole(NodeId nodeId, DeviceId deviceId) Allows a controller instance to give up its current role for a device.
MastershipRole	MastershipStore.requestRole(DeviceId deviceId) Requests role of the local node for the specified device.
MastershipRole	MastershipService.requestRoleFor(DeviceId deviceId) Returns the mastership status of the local controller for a given device forcing master selection if necessary.
MastershipEvent	MastershipStore.setMaster(NodeId nodeId, DeviceId deviceId) Sets a device's role for a specified controller instance.
void	MastershipAdminService.setRole(NodeId instance, DeviceId deviceId, MastershipRole role) Applies the current mastership role for the specified device.
MastershipEvent	MastershipStore.setStandby(NodeId nodeId, DeviceId deviceId) Sets a controller instance's mastership role to STANDBY for a device.

Constructors in org.onosproject.mastership with parameters of type DeviceId

Constructor and Description
MastershipEvent(MastershipEvent.Type type, DeviceId device, RoleInfo info) Creates an event of a given type and for the specified device, role information, and the current time.
MastershipEvent(MastershipEvent.Type type, DeviceId device, RoleInfo info, long time) Creates an event of a given type and for the specified device, master, and time.

Uses of DeviceId in org.onosproject.net

Fields in org.onosproject.net declared as DeviceId

Modifier and Type	Field and Description
static DeviceId	DeviceId.NONE Represents either no device, or an unspecified device.

Methods in org.onosproject.net that return DeviceId

Modifier and Type	Method and Description
DeviceId	ConnectPoint.deviceId() Returns the identifier of the infrastructure device if the connection point belongs to a network element which is indeed an infrastructure device.
static DeviceId	DeviceId.deviceId(String string) Creates a device id using the supplied URI string.
static DeviceId	DeviceId.deviceId(URI uri) Creates a device id using the supplied URI.
DeviceId	Device.id() Returns the device identifier.
DeviceId	DefaultDevice.id()

Constructors in org.onosproject.net with parameters of type DeviceId

Constructor and Description
DefaultDevice(ProviderId providerId, DeviceId id, Device.Type type, String manufacturer, String hwVersion, String swVersion, String serialNumber, org.onlab.packet.ChassisId chassisId, Annotations... annotations) Creates a network element attributed to the specified provider.
HostLocation(DeviceId deviceId, PortNumber portNumber, long time) Creates a new host location using the supplied device & port.

Uses of DeviceId in org.onosproject.net.device

Methods in org.onosproject.net.device with parameters of type DeviceId

Modifier and Type	Method and Description
DeviceEvent	DeviceStore.createOrUpdateDevice(ProviderId providerId, DeviceId deviceId, DeviceDescription deviceDescription) Creates a new infrastructure device, or updates an existing one using the supplied device description.
void	DeviceProviderService.deviceConnected(DeviceId deviceId, DeviceDescription deviceDescription) Signals the core that a device has connected or has been detected somehow.
void	DeviceProviderService.deviceDisconnected(DeviceId deviceId) Signals the core that a device has disconnected or is no longer reachable.
Device	DeviceStore.getDevice(DeviceId deviceId) Returns the device with the specified identifier.
Device	DeviceService.getDevice(DeviceId deviceId) Returns the device with the specified identifier.
Port	DeviceStore.getPort(DeviceId deviceId, PortNumber portNumber) Returns the specified device port.
Port	DeviceService.getPort(DeviceId deviceId, PortNumber portNumber) Returns the port with the specified number and hosted by the given device.
List<Port>	DeviceStore.getPorts(DeviceId deviceId) Returns the list of ports that belong to the specified device.
List<Port>	DeviceService.getPorts(DeviceId deviceId) Returns the list of ports associated with the device.
MastershipRole	DeviceService.getRole(DeviceId deviceId) Returns the current mastership role for the specified device.
Timestamp	DeviceClockService.getTimestamp(DeviceId deviceId) Returns a new timestamp for the specified deviceId.
boolean	DeviceStore.isAvailable(DeviceId deviceId) Indicates whether the specified device is available/online.
boolean	DeviceService.isAvailable(DeviceId deviceId) Indicates whether or not the device is presently online and available.
boolean	DeviceProvider.isReachable(DeviceId deviceId) Checks the reachability (connectivity) of a device from this provider.
boolean	DeviceClockService.isTimestampAvailable(DeviceId deviceId) Checks if this service can issue Timestamp for specified device.
boolean	DeviceClockProviderService.isTimestampAvailable(DeviceId deviceId) Checks if this service can issue Timestamp for specified device.
DeviceEvent	DeviceStore.markOffline(DeviceId deviceId) Removes the specified infrastructure device.
void	DeviceProviderService.portStatusChanged(DeviceId deviceId, PortDescription portDescription) Used to notify the core about port status change of a single port.
void	DeviceProviderService.receivedRoleReply(DeviceId deviceId, MastershipRole requested, MastershipRole response) Notifies the core about the result of a RoleRequest sent to a device.
DeviceEvent	DeviceStore.removeDevice(DeviceId deviceId) Administratively removes the specified device from the store.
void	DeviceAdminService.removeDevice(DeviceId deviceId) Removes the device with the specified identifier.
void	DeviceProvider.roleChanged(DeviceId deviceId, MastershipRole newRole) Notifies the provider of a mastership role change for the specified device as decided by the core.
void	DeviceClockProviderService.setMastershipTerm(DeviceId deviceId, MastershipTerm term) Updates the mastership term for the specified deviceId.
void	DeviceProvider.triggerProbe(DeviceId deviceId) Triggers an asynchronous probe of the specified device, intended to determine whether the device is present or not.
void	DeviceProviderService.updatePorts(DeviceId deviceId, List<PortDescription> portDescriptions) Sends information about all ports of a device.
List<DeviceEvent>	DeviceStore.updatePorts(ProviderId providerId, DeviceId deviceId, List<PortDescription> portDescriptions) Updates the ports of the specified infrastructure device using the given list of port descriptions.
DeviceEvent	DeviceStore.updatePortStatus(ProviderId providerId, DeviceId deviceId, PortDescription portDescription) Updates the port status of the specified infrastructure device using the given port description.

Uses of DeviceId in org.onosproject.net.flow

Methods in org.onosproject.net.flow that return DeviceId

Modifier and Type	Method and Description
DeviceId	FlowRule.deviceId() Returns the identity of the device where this rule applies.
DeviceId	DefaultFlowRule.deviceId()

Methods in org.onosproject.net.flow with parameters of type DeviceId

Modifier and Type	Method and Description
Iterable<FlowEntry>	FlowRuleStore.getFlowEntries(DeviceId deviceId) Returns the flow entries associated with a device.
Iterable<FlowEntry>	FlowRuleService.getFlowEntries(DeviceId deviceId) Returns the collection of flow entries applied on the specified device.
void	FlowRuleProviderService.pushFlowMetrics(DeviceId deviceId, Iterable<FlowEntry> flowEntries) Pushes the collection of flow entries currently applied on the given device.

Constructors in org.onosproject.net.flow with parameters of type DeviceId

Constructor and Description
DefaultFlowEntry(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, FlowEntry.FlowEntryState state, long life, long packets, long bytes, long flowId, int timeout)
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, GroupId groupId, int timeout, boolean permanent)
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, int timeout, boolean permanent)
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, ApplicationId appId, short groupId, int timeout, boolean permanent) Deprecated.
DefaultFlowRule(DeviceId deviceId, TrafficSelector selector, TrafficTreatment treatment, int priority, long flowId, int timeout, boolean permanent)

Uses of DeviceId in org.onosproject.net.host

Methods in org.onosproject.net.host with parameters of type DeviceId

Modifier and Type	Method and Description
Set<Host>	HostStore.getConnectedHosts(DeviceId deviceId) Returns the set of hosts whose location falls on the given device.
Set<Host>	HostService.getConnectedHosts(DeviceId deviceId) Returns the set of hosts whose most recent location is the specified infrastructure device.

Uses of DeviceId in org.onosproject.net.intent.constraint

Methods in org.onosproject.net.intent.constraint that return types with arguments of type DeviceId

Modifier and Type	Method and Description
List<DeviceId>	WaypointConstraint.waypoints()

Constructors in org.onosproject.net.intent.constraint with parameters of type DeviceId

Constructor and Description
ObstacleConstraint(DeviceId... obstacles) Creates a new constraint that the specified device are not passed through.
WaypointConstraint(DeviceId... waypoints) Creates a new waypoint constraint.

Uses of DeviceId in org.onosproject.net.link

Methods in org.onosproject.net.link with parameters of type DeviceId

Modifier and Type	Method and Description
Set<Link>	LinkStore.getDeviceEgressLinks(DeviceId deviceId) Returns all links egressing from the specified device.
Set<Link>	LinkService.getDeviceEgressLinks(DeviceId deviceId) Returns set of all infrastructure links leading from the specified device.
Set<Link>	LinkStore.getDeviceIngressLinks(DeviceId deviceId) Returns all links ingressing from the specified device.
Set<Link>	LinkService.getDeviceIngressLinks(DeviceId deviceId) Returns set of all infrastructure links leading to the specified device.
Set<Link>	LinkService.getDeviceLinks(DeviceId deviceId) Returns set of all infrastructure links leading to and from the specified device.
void	LinkProviderService.linksVanished(DeviceId deviceId) Signals that infrastructure links associated with the specified device have vanished.
void	LinkAdminService.removeLinks(DeviceId deviceId) Removes all infrastructure links leading to and from the specified device.

Uses of DeviceId in org.onosproject.net.packet

Methods in org.onosproject.net.packet that return DeviceId

Modifier and Type	Method and Description
DeviceId	OutboundPacket.sendThrough() Returns the identity of a device through which this packet should be sent.
DeviceId	DefaultOutboundPacket.sendThrough()

Constructors in org.onosproject.net.packet with parameters of type DeviceId

Constructor and Description
DefaultOutboundPacket(DeviceId sendThrough, TrafficTreatment treatment, ByteBuffer data) Creates an immutable outbound packet.

Uses of DeviceId in org.onosproject.net.provider

Methods in org.onosproject.net.provider with parameters of type DeviceId

Modifier and Type	Method and Description
protected P	AbstractProviderRegistry.getProvider(DeviceId deviceId) Returns the provider for the specified device ID based on URI scheme.

Uses of DeviceId in org.onosproject.net.topology

Methods in org.onosproject.net.topology that return DeviceId

Modifier and Type	Method and Description
DeviceId	TopologyVertex.deviceId() Returns the associated infrastructure device identification.
DeviceId	DefaultTopologyVertex.deviceId()
DeviceId	TopologyCluster.root() Returns the device identifier of the cluster root device.
DeviceId	DefaultTopologyCluster.root()

Methods in org.onosproject.net.topology that return types with arguments of type DeviceId

Modifier and Type	Method and Description
Set<DeviceId>	TopologyStore.getClusterDevices(Topology topology, TopologyCluster cluster) Returns the cluster of the specified topology.
Set<DeviceId>	TopologyService.getClusterDevices(Topology topology, TopologyCluster cluster) Returns the set of devices that belong to the specified cluster.

Methods in org.onosproject.net.topology with parameters of type DeviceId

Modifier and Type	Method and Description
Set<Path>	TopologyStore.getPaths(Topology topology, DeviceId src, DeviceId dst) Returns the set of pre-computed shortest paths between src and dest.
Set<Path>	TopologyService.getPaths(Topology topology, DeviceId src, DeviceId dst) Returns the set of all shortest paths, precomputed in terms of hop-count, between the specified source and destination devices.
Set<Path>	TopologyStore.getPaths(Topology topology, DeviceId src, DeviceId dst, LinkWeight weight) Computes and returns the set of shortest paths between src and dest.
Set<Path>	TopologyService.getPaths(Topology topology, DeviceId src, DeviceId dst, LinkWeight weight) Returns the set of all shortest paths, computed using the supplied edge-weight entity, between the specified source and destination devices.

Constructors in org.onosproject.net.topology with parameters of type DeviceId

Constructor and Description
DefaultTopologyCluster(ClusterId id, int deviceCount, int linkCount, DeviceId root) Creates a new topology cluster descriptor with the specified attributes.
DefaultTopologyVertex(DeviceId deviceId) Creates a new topology vertex.