Package org.jgroups.protocols

Class UFC_NB

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.FlowControl

org.jgroups.protocols.UFC

org.jgroups.protocols.UFC_NB

All Implemented Interfaces:

Lifecycle

public class UFC_NB
extends UFC

Non-blocking alternative to UFC.

JIRA: https://issues.redhat.com/browse/JGRP-2172

Since:

4.0.4

Field Summary

Fields

Modifier and Type	Field	Description
protected Future<?>	credit_send_task
protected int	max_queue_size
protected final Consumer<Message>	send_function

Fields inherited from class org.jgroups.protocols.UFC

sent, UFC_CREDIT_REQUEST_HDR, UFC_REPLENISH_HDR

Fields inherited from class org.jgroups.protocols.FlowControl

frag_size, max_block_time, max_credits, min_credits, min_threshold, num_credit_requests_received, num_credit_requests_sent, num_credit_responses_received, num_credit_responses_sent, num_msgs_dropped, received, running

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
UFC_NB()

Method Summary

Modifier and Type	Method	Description
protected <T extends Credit> T	createCredit(int initial_credits)
int	getMaxQueueSize()
int	getNumberOfQueuedMessages()
int	getNumberOfQueuings()
int	getQueuedMessagesTo(Address dest)
int	getQueuedSize()
protected Object	handleDownMessage(Message msg, int length)
boolean	isQueuingTo(Address dest)
protected void	sendCreditRequestsIfNeeded()	Checks the sent table: if some credits are in queueing mode and credits left are less than min_credits: send a credit request
UFC_NB	setMaxQueueSize(int s)
void	start()	This method is called on a JChannel.connect(String); starts work.
void	stop()	Called on a JChannel.disconnect(); stops work (e.g.

Methods inherited from class org.jgroups.protocols.UFC

getAverageTimeBlocked, getCreditRequestHeader, getNumberOfBlockings, getReplenishHeader, getSenderCreditsFor, handleCredit, handleMulticastMessage, handleViewChange, printCredits, printSenderCredits, resetStats, unblock

Methods inherited from class org.jgroups.protocols.FlowControl

adjustCredit, down, down, getMaxBlockTime, getMaxCredits, getMinCredits, getMinThreshold, getNumberOfCreditRequestsReceived, getNumberOfCreditRequestsSent, getNumberOfCreditResponsesReceived, getNumberOfCreditResponsesSent, getReceiverCreditsFor, handleConfigEvent, handleCreditRequest, handleUpEvent, init, printMap, printReceiverCredits, sendCredit, sendCreditRequest, setMaxBlockTime, setMaxCredits, setMinCredits, setMinThreshold, up, up, up

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString

Methods inherited from class java.lang.Object

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

Field Details

max_queue_size

protected int max_queue_size

send_function

protected final Consumer<Message> send_function

credit_send_task

protected Future<?> credit_send_task

Constructor Details

UFC_NB

public UFC_NB()

Method Details

getMaxQueueSize

public int getMaxQueueSize()

setMaxQueueSize

public UFC_NB setMaxQueueSize(int s)

getNumberOfQueuedMessages

public int getNumberOfQueuedMessages()

getQueuedSize

public int getQueuedSize()

getNumberOfQueuings

public int getNumberOfQueuings()

isQueuingTo

public boolean isQueuingTo(Address dest)

getQueuedMessagesTo

public int getQueuedMessagesTo(Address dest)

start

public void start()
           throws Exception

Description copied from class: Protocol

This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.

Specified by:

start in interface Lifecycle

Overrides:

start in class FlowControl

Throws:

Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) will throw an exception

stop

public void stop()

Description copied from class: Protocol

Called on a JChannel.disconnect(); stops work (e.g. by closing multicast socket). Will be called from top to bottom.

Specified by:

stop in interface Lifecycle

Overrides:

stop in class UFC

handleDownMessage

protected Object handleDownMessage(Message msg,
 int length)

Overrides:

handleDownMessage in class UFC

createCredit

protected <T extends Credit> T createCredit(int initial_credits)

Overrides:

createCredit in class UFC

sendCreditRequestsIfNeeded

protected void sendCreditRequestsIfNeeded()

Checks the sent table: if some credits are in queueing mode and credits left are less than min_credits: send a credit request