DatagramProgressNtf (UnetStack 3.0.2 API)

org.arl.unet.DatagramProgressNtf

Notification of datagram transfer progress.

Field Summary

Fields
Modifiers	Name	Description
`protected int`	`id`
`protected boolean`	`incoming`
`protected int`	`peer`
`protected int`	`total`
`protected int`	`transferred`

Constructor Summary

Constructors
Constructor and description
`DatagramProgressNtf ()`
`DatagramProgressNtf (Message request)` Create a progress notification for a specified datagram.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`int`	`getID()` Gets the transfer ID.
	`int`	`getPeer()` Gets the peer node address.
	`int`	`getTotal()` Gets the total number of bytes in datagram.
	`int`	`getTransferred()` Gets the number of bytes transferred.
	`boolean`	`isIncoming()` Checks if the datagram transfer is incoming.
	`void`	`setID(int id)` Sets transfer ID.
	`void`	`setIncoming(boolean incoming)` Sets the datagram transfer direction.
	`void`	`setPeer(int peer)` Sets peer node address.
	`void`	`setTotal(int total)` Sets total number of bytes in datagram.
	`void`	`setTransferred(int transferred)` Sets number of bytes transferred.
	`String`	`toString()`

Inherited Methods Summary

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

- Field Detail
  - protected int id
  - protected boolean incoming
  - protected int peer
  - protected int total
  - protected int transferred
- Constructor Detail
  - public DatagramProgressNtf()
  - public DatagramProgressNtf(Message request)
    
    Create a progress notification for a specified datagram.
    Parameters:
    request - original datagram request
- Method Detail
  - public int getID()
    
    Gets the transfer ID.
    Returns:
    transfer ID
  - public int getPeer()
    
    Gets the peer node address.
    Returns:
    peer node address
  - public int getTotal()
    
    Gets the total number of bytes in datagram.
    Returns:
    total number of bytes in datagram
  - public int getTransferred()
    
    Gets the number of bytes transferred.
    Returns:
    number of bytes transferred
  - public boolean isIncoming()
    
    Checks if the datagram transfer is incoming.
    Returns:
    true if the transfer is incoming, false if it is outgoing
  - public void setID(int id)
    
    Sets transfer ID.
    Parameters:
    id - transfer ID
  - public void setIncoming(boolean incoming)
    
    Sets the datagram transfer direction.
    Parameters:
    incoming - transfer direction (incoming = true, outgoing = false)
  - public void setPeer(int peer)
    
    Sets peer node address.
    Parameters:
    peer - node address
  - public void setTotal(int total)
    
    Sets total number of bytes in datagram.
    Parameters:
    total - number of bytes in datagram
  - public void setTransferred(int transferred)
    
    Sets number of bytes transferred.
    Parameters:
    transferred - number of bytes transferred
  - @Override public String toString()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class DatagramProgressNtf

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected int id

protected boolean incoming

protected int peer

protected int total

protected int transferred

Constructor Detail

public DatagramProgressNtf()

public DatagramProgressNtf(Message request)

Method Detail

public int getID()

public int getPeer()

public int getTotal()

public int getTransferred()

public boolean isIncoming()

public void setID(int id)

public void setIncoming(boolean incoming)

public void setPeer(int peer)

public void setTotal(int total)

public void setTransferred(int transferred)

@Override public String toString()