ProgressNtf (unet-framework 7.0.0 API)

org.arl.unet.ProgressNtf

Notification of data transfer progress.

Field Summary

Fields
Modifiers	Name	Description
`protected java.lang.String`	`filename`
`protected boolean`	`incoming`
`protected int`	`peer`
`protected long`	`total`
`protected long`	`transferred`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`filename`
`boolean`	`incoming`
`int`	`peer`
`long`	`total`
`long`	`transferred`

Constructor Summary

Constructors
Constructor and description
`ProgressNtf ()`
`ProgressNtf (org.arl.fjage.Message request)` Create a progress notification for a specified request.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getFilename()` Gets the name of the file being transferred.
	`int`	`getPeer()` Gets the peer node address.
	`long`	`getTotal()` Gets the total number of bytes of data.
	`long`	`getTransferred()` Gets the number of bytes transferred.
	`boolean`	`isIncoming()` Checks if the data transfer is incoming.
	`void`	`setFilename(java.lang.String filename)` Sets the name of the file being transferred.
	`void`	`setIncoming(boolean incoming)` Sets the data transfer direction.
	`void`	`setPeer(int peer)` Sets peer node address.
	`void`	`setTotal(long total)` Sets total number of bytes of data.
	`void`	`setTransferred(long transferred)` Sets number of bytes transferred.
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.arl.fjage.Message`	org.arl.fjage.Message#toString(), org.arl.fjage.Message#setPerformative(org.arl.fjage.Performative), org.arl.fjage.Message#getPerformative(), org.arl.fjage.Message#setRecipient(org.arl.fjage.AgentID), org.arl.fjage.Message#getRecipient(), org.arl.fjage.Message#setSender(org.arl.fjage.AgentID), org.arl.fjage.Message#getSender(), org.arl.fjage.Message#setMessageID(java.lang.String), org.arl.fjage.Message#getMessageID(), org.arl.fjage.Message#setInReplyTo(java.lang.String), org.arl.fjage.Message#getInReplyTo(), org.arl.fjage.Message#setSentAt(long), org.arl.fjage.Message#getSentAt(), org.arl.fjage.Message#getJsonCache(), org.arl.fjage.Message#setJsonCache(java.lang.String), org.arl.fjage.Message#wait(long, int), org.arl.fjage.Message#wait(long), org.arl.fjage.Message#wait(), org.arl.fjage.Message#equals(java.lang.Object), org.arl.fjage.Message#hashCode(), org.arl.fjage.Message#getClass(), org.arl.fjage.Message#notify(), org.arl.fjage.Message#notifyAll()

- Field Detail
  - protected java.lang.String filename
  - protected boolean incoming
  - protected int peer
  - protected long total
  - protected long transferred
- Property Detail
  - java.lang.String filename
  - boolean incoming
  - int peer
  - long total
  - long transferred
- Constructor Detail
  - public ProgressNtf()
  - public ProgressNtf(org.arl.fjage.Message request)
    
    Create a progress notification for a specified request.
    Parameters:
    request - original request
- Method Detail
  - public java.lang.String getFilename()
    
    Gets the name of the file being transferred.
    Returns:
    name of the file
  - public int getPeer()
    
    Gets the peer node address.
    Returns:
    peer node address
  - public long getTotal()
    
    Gets the total number of bytes of data.
    Returns:
    total number of bytes of data
  - public long getTransferred()
    
    Gets the number of bytes transferred.
    Returns:
    number of bytes transferred
  - public boolean isIncoming()
    
    Checks if the data transfer is incoming.
    Returns:
    true if the transfer is incoming, false if it is outgoing
  - public void setFilename(java.lang.String filename)
    
    Sets the name of the file being transferred.
    Parameters:
    filename - name of the file
  - public void setIncoming(boolean incoming)
    
    Sets the data 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(long total)
    
    Sets total number of bytes of data.
    Parameters:
    total - number of bytes of data
  - public void setTransferred(long transferred)
    
    Sets number of bytes transferred.
    Parameters:
    transferred - number of bytes transferred
  - @java.lang.Override public java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Java] Class ProgressNtf

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected java.lang.String filename

protected boolean incoming

protected int peer

protected long total

protected long transferred

Property Detail

java.lang.String filename

boolean incoming

int peer

long total

long transferred

Constructor Detail

public ProgressNtf()

public ProgressNtf(org.arl.fjage.Message request)

Method Detail

public java.lang.String getFilename()

public int getPeer()

public long getTotal()

public long getTransferred()

public boolean isIncoming()

public void setFilename(java.lang.String filename)

public void setIncoming(boolean incoming)

public void setPeer(int peer)

public void setTotal(long total)

public void setTransferred(long transferred)

@java.lang.Override public java.lang.String toString()