org.nustaq.fastcast.impl

Class PacketSendBuffer

java.lang.Object

org.nustaq.fastcast.impl.PacketSendBuffer

All Implemented Interfaces:

FCPublisher

public class PacketSendBuffer
extends Object
implements FCPublisher

packet buffer backed by binary struct array. Can be used as sender with ring buffered history.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG_LAT
static String	KEEP_SUBS_NODEID
long	lastMsgFlush
static int	RETRANS_MEM
static boolean	RETRANSDEBUG

Constructor Summary

Constructors

Constructor and Description
PacketSendBuffer(PhysicalTransport trans, String nodeId, Topic entry)

Method Summary

Modifier and Type	Method and Description
FCPublisher	batchOnLimit(boolean doBatch) decides wether to start batching once rate limit is reached.
void	flush()
void	free()
int	getPacketRateLimit()
Topic	getTopicEntry()
int	getTopicId()
protected void	initDropMsgPacket(String nodeId)
boolean	isBatchOnLimit(boolean doBatch)
boolean	isUnordered()
boolean	offer(String receiverNodeId, byte[] b, int start, int len, boolean doFlush) send a byte[] message
boolean	offer(String subscriberNodeId, org.nustaq.offheap.bytez.ByteSource msg, boolean doFlush) send a byte[] message
boolean	offer(String receiverNodeId, org.nustaq.offheap.bytez.ByteSource msg, long start, int len, boolean doFlush) send a byte[] message
protected boolean	offerNoLock(String receiverNodeId, org.nustaq.offheap.bytez.ByteSource msg, long start, int len, boolean doFlush)
void	setPacketRateLimit(int limit)
void	setUnordered(boolean unordered)

Methods inherited from class java.lang.Object

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

Field Detail

RETRANSDEBUG

public static boolean RETRANSDEBUG

KEEP_SUBS_NODEID

public static final String KEEP_SUBS_NODEID

See Also:

Constant Field Values

DEBUG_LAT

public static boolean DEBUG_LAT

RETRANS_MEM

public static int RETRANS_MEM

lastMsgFlush

public volatile long lastMsgFlush

Constructor Detail

PacketSendBuffer

public PacketSendBuffer(PhysicalTransport trans,
                        String nodeId,
                        Topic entry)

Method Detail

initDropMsgPacket

protected void initDropMsgPacket(String nodeId)

free

public void free()

getTopicEntry

public Topic getTopicEntry()

isUnordered

public boolean isUnordered()

setUnordered

public void setUnordered(boolean unordered)

offerNoLock

protected boolean offerNoLock(String receiverNodeId,
                              org.nustaq.offheap.bytez.ByteSource msg,
                              long start,
                              int len,
                              boolean doFlush)

offer

public boolean offer(String receiverNodeId,
                     byte[] b,
                     int start,
                     int len,
                     boolean doFlush)

Description copied from interface: FCPublisher

send a byte[] message

Specified by:

offer in interface FCPublisher

Parameters:

receiverNodeId - - null to send to all subscribers, aNodeId to target a specific node

b - - bytes to send

start - - start offset

len - - number of bytes to send

doFlush - - if true, the currently written packet is sent immediately EXCEPT your send rate is > pps limit (packets per second) only set to true if you care mostly about latency instead of throughput. fast cast automatically flushes after one ms. So a value of true only makes sense if you care about micros.

Returns:

true if the message has been sent, false if limits/buffers are full.

offer

public boolean offer(String receiverNodeId,
                     org.nustaq.offheap.bytez.ByteSource msg,
                     long start,
                     int len,
                     boolean doFlush)

Description copied from interface: FCPublisher

send a byte[] message

Specified by:

offer in interface FCPublisher

Parameters:

receiverNodeId - - null to send to all subscribers, aNodeId to target a specific node

msg - - byte source containing the message bytes

start - - start offset

len - - number of bytes to send

doFlush - - if true, the currently written packet is sent immediately EXCEPT your send rate is > pps limit (packets per second) only set to true if you care mostly about latency instead of throughput. fast cast automatically flushes after one ms. So a value of true only makes sense if you care about micros.

Returns:

true if the message has been sent, false if limits/buffers are full.

offer

public boolean offer(String subscriberNodeId,
                     org.nustaq.offheap.bytez.ByteSource msg,
                     boolean doFlush)

Description copied from interface: FCPublisher

send a byte[] message

Specified by:

offer in interface FCPublisher

Parameters:

subscriberNodeId - - null to send to all subscribers, aNodeId to target a specific node

msg - - byte source containing the message bytes.

doFlush - - if true, the currently written packet is sent immediately EXCEPT your send rate is > pps limit (packets per second) only set to true if you care mostly about latency instead of throughput. fast cast automatically flushes after one ms. So a value of true only makes sense if you care about micros.

Returns:

true if the message has been sent, false if limits/buffers are full.

getTopicId

public int getTopicId()

Specified by:

getTopicId in interface FCPublisher

setPacketRateLimit

public void setPacketRateLimit(int limit)

Specified by:

setPacketRateLimit in interface FCPublisher

getPacketRateLimit

public int getPacketRateLimit()

Specified by:

getPacketRateLimit in interface FCPublisher

batchOnLimit

public FCPublisher batchOnLimit(boolean doBatch)

Description copied from interface: FCPublisher

decides wether to start batching once rate limit is reached. Default is true. Note this must be set to false in case there are unreliable or unordered receivers amongst subscribers. Batching means to pack several small messages into one datagram packet.

Specified by:

batchOnLimit in interface FCPublisher

Returns:

isBatchOnLimit

public boolean isBatchOnLimit(boolean doBatch)

Specified by:

isBatchOnLimit in interface FCPublisher

flush

public void flush()

Specified by:

flush in interface FCPublisher