PhyTickerBehavior (UnetStack 3.4.0 API)

org.arl.unet.phy.PhyTickerBehavior

A behavior that is executed every specified period based on the physical layer clock.
If the PHY supports a more accurate clock than the local clock used by the TickerBehavior, then this behavior may be used instead of the TickerBehavior. Moreover, this becomes important for use in slotted protocols, if the PHY clock is synchronized across the network.
The onTick() method of this behavior is called at intervals defined by the period.

Field Summary

Fields
Modifiers	Name	Description
`protected long`	`period`
`protected AgentID`	`phy`
`protected boolean`	`quit`
`protected long`	`startTime`
`protected int`	`ticks`
`protected long`	`wakeupTime`

Constructor Summary

Constructors
Constructor and description
`PhyTickerBehavior (long millis)` Creates a behavior that is executed every specified period.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`action()` This method calls onTick() once every specified period.
	`boolean`	`done()` Returns true once stop() is called, false otherwise.
	`protected long`	`getPhyTime()`
	`int`	`getTickCount()` Returns the number of times the onTick() method of this behavior has been called (including any ongoing call).
	`void`	`onStart()` Computes the wakeup time for the first execution of this behavior.
	`void`	`onTick()` This method is called once every specified period.
	`void`	`reset()` Resets the behavior, allowing it to be used again.
	`void`	`stop()` Terminates the behavior.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Behavior`	`onStart, done, action, println, compareTo, compareTo, getPriority, reset, agentForService, agentForService, agentsForService, agentsForService, isBlocked, block, block, restart, onEnd, agent, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected long period
  - protected AgentID phy
  - protected boolean quit
  - protected long startTime
  - protected int ticks
  - protected long wakeupTime
- Constructor Detail
  - public PhyTickerBehavior(long millis)
    
    Creates a behavior that is executed every specified period.
    Parameters:
    millis - period in milliseconds.
- Method Detail
  - @Override public final void action()
    
    This method calls onTick() once every specified period.
    See Also:
    Behavior.action
  - @Override public boolean done()
    
    Returns true once stop() is called, false otherwise.
    Returns:
    true once stop() is called, false otherwise.
    See Also:
    Behavior.done
  - protected long getPhyTime()
  - public final int getTickCount()
    
    Returns the number of times the onTick() method of this behavior has been called (including any ongoing call).
    Returns:
    the number of times the onTick() method has been called.
  - @Override public void onStart()
    
    Computes the wakeup time for the first execution of this behavior.
    See Also:
    Behavior.onStart
  - public void onTick()
    
    This method is called once every specified period. The method is usually overridden by a behavior.
  - @Override public void reset()
    
    Resets the behavior, allowing it to be used again.
    See Also:
    Behavior.reset
  - public void stop()
    
    Terminates the behavior.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class PhyTickerBehavior

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected long period

protected AgentID phy

protected boolean quit

protected long startTime

protected int ticks

protected long wakeupTime

Constructor Detail

public PhyTickerBehavior(long millis)

Method Detail

@Override public final void action()

@Override public boolean done()

protected long getPhyTime()

public final int getTickCount()

@Override public void onStart()

public void onTick()

@Override public void reset()

public void stop()