TxRawFrameReq (UnetStack 3.4.0 API)

org.arl.unet.phy.TxRawFrameReq

Raw frame transmission request. A raw frame is one without the usual physical layer headers. Unless appropriately formatted with appropriate headers, a raw frame will be detected as a bad frame on the receiving end.

Field Summary

Fields
Modifiers	Name	Description
`protected byte[]`	`data`
`protected Priority`	`priority`
`protected Long`	`txTime`
`protected int`	`type`
`protected boolean`	`wakeup`

Properties Summary

Properties
Type	Name and description
`byte[]`	`data`
`Priority`	`priority`
`Long`	`txTime`
`Long`	`txTime`
`int`	`type`

Constructor Summary

Constructors
Constructor and description
`TxRawFrameReq ()` Constructs empty raw frame request.
`TxRawFrameReq (AgentID recipient)` Constructs empty raw frame request for given agent id.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`byte[]`	`getData()` Gets the data in bytes.
	`Priority`	`getPriority()` Gets the priority of the datagram.
	`Long`	`getTxTime()` Gets the time at which it needs to be transmitted.
	`int`	`getType()` Gets the type of channel.
	`boolean`	`getWakeup()` Checks whether a wakeup signal should be sent before the frame.
	`void`	`setData(byte[] data)` Sets data to be send across.
	`void`	`setPriority(Priority priority)` Sets the priority of the datagram.
	`void`	`setTxTime(Long time)` Sets transmission timestamp. transmission will be triggered at the specified time.
	`void`	`setTxTime(long time)` Sets transmission timestamp. transmission will be triggered at the specified time.
	`void`	`setType(int type)` Sets the channel type.
	`void`	`setWakeup(boolean enabled)` Enables/disables sending of wakeup signal before frame.
	`String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Message`	`setPerformative, toString, getSender, setMessageID, getSentAt, setRecipient, getInReplyTo, setSentAt, setSender, getPerformative, getRecipient, getMessageID, setInReplyTo, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected byte[] data
  - protected Priority priority
  - protected Long txTime
  - protected int type
  - protected boolean wakeup
- Property Detail
  - byte[] data
  - Priority priority
  - Long txTime
  - Long txTime
  - int type
- Constructor Detail
  - public TxRawFrameReq()
    
    Constructs empty raw frame request.
  - public TxRawFrameReq(AgentID recipient)
    
    Constructs empty raw frame request for given agent id.
    Parameters:
    recipient - Agent ID
- Method Detail
  - public byte[] getData()
    
    Gets the data in bytes.
    Returns:
    data in bytes
  - public Priority getPriority()
    
    Gets the priority of the datagram.
    Returns:
    priority
  - public Long getTxTime()
    
    Gets the time at which it needs to be transmitted.
    Returns:
    transmission timestamp in us if specified, null otherwise
  - public int getType()
    
    Gets the type of channel.
    Returns:
    type of channel (Physical.DATA or Physical.CONTROL)
  - public boolean getWakeup()
    
    Checks whether a wakeup signal should be sent before the frame.
    Returns:
    true to send wakeup signal, false otherwise
  - public void setData(byte[] data)
    
    Sets data to be send across.
    Parameters:
    data - in bytes
  - public void setPriority(Priority priority)
    
    Sets the priority of the datagram. A priority are advisory, and an agent may choose to ignore it, if it does not support prioritization.
    Parameters:
    priority - priority assigned to the request.
  - public void setTxTime(Long time)
    
    Sets transmission timestamp. transmission will be triggered at the specified time. PhysicalCapability.TIMED_TX
    Parameters:
    time - transmission time in us, or null
  - public void setTxTime(long time)
    
    Sets transmission timestamp. transmission will be triggered at the specified time. PhysicalCapability.TIMED_TX
    Parameters:
    time - transmission time in us, or null
  - public void setType(int type)
    
    Sets the channel type.
    Parameters:
    type - of channel (Physical.DATA or Physical.CONTROL)
  - public void setWakeup(boolean enabled)
    
    Enables/disables sending of wakeup signal before frame.
    Parameters:
    enabled - true if wakeup signal to be sent
  - @Override public String toString()

Summary:
Field
Property
Constructor
Method

[Java] Class TxRawFrameReq

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected byte[] data

protected Priority priority

protected Long txTime

protected int type

protected boolean wakeup

Property Detail

byte[] data

Priority priority

Long txTime

Long txTime

int type

Constructor Detail

public TxRawFrameReq()

public TxRawFrameReq(AgentID recipient)

Method Detail

public byte[] getData()

public Priority getPriority()

public Long getTxTime()

public int getType()

public boolean getWakeup()

public void setData(byte[] data)

public void setPriority(Priority priority)

public void setTxTime(Long time)

public void setTxTime(long time)

public void setType(int type)

public void setWakeup(boolean enabled)

@Override public String toString()