com.madara.transport

Class QoSTransportSettings

java.lang.Object

com.madara.MadaraJNI

com.madara.transport.TransportSettings

com.madara.transport.QoSTransportSettings

public class QoSTransportSettings
extends TransportSettings

Constructor Summary

Constructors

Constructor and Description
QoSTransportSettings()
QoSTransportSettings(QoSTransportSettings transportSettings)

Method Summary

Modifier and Type	Method and Description
void	addFilter(BufferFilter filter) Adds a BufferFilter to the filter chain.
void	addRebroadcastFilter(AggregateFilter filter) Adds an aggregate update filter that will be applied before rebroadcasting, after individual record filters.
void	addRebroadcastFilter(KnowledgeType type, RecordFilter filter) Adds a filter that will be applied to certain types after receiving and before rebroadcasting, if time-to-live is greater than 0
void	addReceiveFilter(AggregateFilter filter) Adds an aggregate update filter that will be applied after receiving, after individual record filters.
void	addReceiveFilter(KnowledgeType type, RecordFilter filter) Adds an aggregate filter for a map of variables to values before applying updates to the Knowledge_Base
void	addSendFilter(AggregateFilter filter) Adds an aggregate update filter that will be applied before sending, after individual record filters.
void	addSendFilter(KnowledgeType type, RecordFilter filter) Adds a filter that will be applied to certain types before sending
void	clearBufferFilters() Clears the list of buffer filters
void	enableParticipantTtl(int ttl) Enables participation in rebroadcasts up to a certain ttl value
protected void	finalize() Cleans up underlying C resources
void	free() Deletes the C instantiation.
int	getDeadline() Gets the deadline (seconds)
int	getParticipantTtl() Gets the rebroadcast time-to-live for all rebroadcasted packets
int	getRebroadcastTtl() Gets the rebroadcast time-to-live for all sent packets
int	getSendBandwidthLimit() Gets the send bandwidth limit
int	getTotalBandwidthLimit() Gets the total bandwidth limit
void	load(java.lang.String filename) Loads the transport settings from a KnowledgeBase context file
void	save(java.lang.String filename) Saves the transport settings as a KnowledgeBase to a file
void	setDeadline(int deadline) Sets the deadline (seconds)
void	setRebroadcastTtl(int ttl) Sets the rebroadcast time-to-live for all sent packets
void	setSendBandwidthLimit(int limit) Sets the send bandwidth limit
void	setTotalBandwidthLimit(int limit) Sets the total bandwidth limit

Methods inherited from class com.madara.transport.TransportSettings

getHosts, getId, getOnDataReceivedLogic, getProcesses, getQueueLength, getReliability, getResendAttempts, getType, getWriteDomain, setHosts, setId, setOnDataReceivedLogic, setProcesses, setQueueLength, setReliability, setResendAttempts, setType, setWriteDomain

Methods inherited from class com.madara.MadaraJNI

getCPtr, setCPtr, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QoSTransportSettings

public QoSTransportSettings()

QoSTransportSettings

public QoSTransportSettings(QoSTransportSettings transportSettings)

Method Detail

addFilter

public void addFilter(BufferFilter filter)

Adds a BufferFilter to the filter chain. Buffer filters are applied just after all other filters on send and before all other filters on receive.

Parameters:

filter - a filter to encode and decode buffers

clearBufferFilters

public void clearBufferFilters()

Clears the list of buffer filters

addRebroadcastFilter

public void addRebroadcastFilter(KnowledgeType type,
                                 RecordFilter filter)

Adds a filter that will be applied to certain types after receiving and before rebroadcasting, if time-to-live is greater than 0

Parameters:

type - the types to add the filter to

filter - Madara callback function

addRebroadcastFilter

public void addRebroadcastFilter(AggregateFilter filter)

Adds an aggregate update filter that will be applied before rebroadcasting, after individual record filters.

Parameters:

filter - Madara callback function

addSendFilter

public void addSendFilter(KnowledgeType type,
                          RecordFilter filter)

Adds a filter that will be applied to certain types before sending

Parameters:

type - the types to add the filter to

filter - Madara callback function

addSendFilter

public void addSendFilter(AggregateFilter filter)

Adds an aggregate update filter that will be applied before sending, after individual record filters.

Parameters:

filter - Madara callback function

addReceiveFilter

public void addReceiveFilter(KnowledgeType type,
                             RecordFilter filter)

Adds an aggregate filter for a map of variables to values before applying updates to the Knowledge_Base

Parameters:

type - the types to add the filter to

filter - Madara callback function

addReceiveFilter

public void addReceiveFilter(AggregateFilter filter)

Adds an aggregate update filter that will be applied after receiving, after individual record filters.

Parameters:

filter - Madara callback function

setRebroadcastTtl

public void setRebroadcastTtl(int ttl)

Sets the rebroadcast time-to-live for all sent packets

Parameters:

ttl - the time-to-live

getRebroadcastTtl

public int getRebroadcastTtl()

Gets the rebroadcast time-to-live for all sent packets

Returns:

the rebroadcast time-to-live

enableParticipantTtl

public void enableParticipantTtl(int ttl)

Enables participation in rebroadcasts up to a certain ttl value

Parameters:

ttl - the time-to-live

getParticipantTtl

public int getParticipantTtl()

Gets the rebroadcast time-to-live for all rebroadcasted packets

Returns:

the rebroadcast time-to-live

setSendBandwidthLimit

public void setSendBandwidthLimit(int limit)

Sets the send bandwidth limit

Parameters:

limit - the bandwidth limit for sending packets

getSendBandwidthLimit

public int getSendBandwidthLimit()

Gets the send bandwidth limit

Returns:

the bandwidth limit for sending packets

setTotalBandwidthLimit

public void setTotalBandwidthLimit(int limit)

Sets the total bandwidth limit

Parameters:

limit - the bandwidth limit for all packets

getTotalBandwidthLimit

public int getTotalBandwidthLimit()

Gets the total bandwidth limit

Returns:

the bandwidth limit for all packets

setDeadline

public void setDeadline(int deadline)

Sets the deadline (seconds)

Overrides:

setDeadline in class TransportSettings

Parameters:

deadline - the maximum lifetime for all packets in seconds

getDeadline

public int getDeadline()

Gets the deadline (seconds)

Overrides:

getDeadline in class TransportSettings

Returns:

the maximum lifetime for all packets in seconds

save

public void save(java.lang.String filename)

Saves the transport settings as a KnowledgeBase to a file

Overrides:

save in class TransportSettings

Parameters:

filename - the file to save the knowledge base to

load

public void load(java.lang.String filename)

Loads the transport settings from a KnowledgeBase context file

Overrides:

load in class TransportSettings

Parameters:

filename - the file to save the knowledge base to

free

public void free()

Deletes the C instantiation. To prevent memory leaks, this must be called before an instance of WaitSettings gets garbage collected

Overrides:

free in class TransportSettings

finalize

protected void finalize()
                 throws java.lang.Throwable

Cleans up underlying C resources

Overrides:

finalize in class TransportSettings

Throws:

java.lang.Throwable - necessary for override but unused