org.nustaq.fastcast.api

Interface FCPublisher

All Known Implementing Classes:

PacketSendBuffer

public interface FCPublisher

interface used to send messages. obtained like 'fastCast.onTransport("default").publish("stream");' Created by ruedi on 29.11.2014.

Method Summary

Modifier and Type	Method and Description
FCPublisher	batchOnLimit(boolean doBatch) decides wether to start batching once rate limit is reached.
void	flush()
int	getPacketRateLimit()
int	getTopicId()
boolean	isBatchOnLimit(boolean doBatch)
boolean	offer(String receiverNodeId, byte[] b, int start, int len, boolean doFlush) send a byte[] message
boolean	offer(String receiverNodeId, 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
void	setPacketRateLimit(int limit)

Method Detail

offer

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

send a byte[] message

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

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

send a byte[] message

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

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

send a byte[] message

Parameters:

receiverNodeId - - 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

int getTopicId()

flush

void flush()

setPacketRateLimit

void setPacketRateLimit(int limit)

getPacketRateLimit

int getPacketRateLimit()

batchOnLimit

FCPublisher batchOnLimit(boolean doBatch)

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.

Parameters:

doBatch -

Returns:

isBatchOnLimit

boolean isBatchOnLimit(boolean doBatch)