org.nustaq.fastcast.api.util

Class ObjectSubscriber

java.lang.Object

org.nustaq.fastcast.api.util.ByteArraySubscriber

org.nustaq.fastcast.api.util.ObjectSubscriber

All Implemented Interfaces:

FCSubscriber

public abstract class ObjectSubscriber
extends ByteArraySubscriber

Created by ruedi on 13.12.14. A subscriber implementation receiving and automatically decoding serialized objects. By default it uses a dedicated thread for delivery to avoid blocking the receiverThread pulling data packets from the network.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.nustaq.serialization.simpleapi.FSTCoder	coder
protected boolean	decodeInReceiver

Fields inherited from class org.nustaq.fastcast.api.util.ByteArraySubscriber

executor, tmpBuf

Constructor Summary

Constructors

Constructor and Description
ObjectSubscriber()
ObjectSubscriber(boolean dedicatedThread)
ObjectSubscriber(boolean dedicatedThread, Class... preregister)
ObjectSubscriber(Class... preregister)

Method Summary

Modifier and Type	Method and Description
ObjectSubscriber	decodeInReceiverThread(boolean b) default is false.
void	messageReceived(String sender, long sequence, byte[] bytes, int off, int len) note: this is not called in case decodeInReceiver is true or no dedicated thread is pressent.
void	messageReceived(String sender, long sequence, org.nustaq.offheap.bytez.Bytez b, long off, int len) a message has been defragmented and received.
protected abstract void	objectReceived(String sender, long sequence, Object msg)

Methods inherited from class org.nustaq.fastcast.api.util.ByteArraySubscriber

dropped, senderBootstrapped, senderTerminated

Methods inherited from class java.lang.Object

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

Field Detail

coder

protected org.nustaq.serialization.simpleapi.FSTCoder coder

decodeInReceiver

protected boolean decodeInReceiver

Constructor Detail

ObjectSubscriber

public ObjectSubscriber(boolean dedicatedThread,
                        Class... preregister)

ObjectSubscriber

public ObjectSubscriber(Class... preregister)

ObjectSubscriber

public ObjectSubscriber(boolean dedicatedThread)

ObjectSubscriber

public ObjectSubscriber()

Method Detail

decodeInReceiverThread

public ObjectSubscriber decodeInReceiverThread(boolean b)

default is false. If true, deserialization is done directly inside the messaging thread saving a tmp byte array alloc for each incoming message. Downside is possible slowdown / packet loss in case of large messages coming in.

Parameters:

b -

Returns:

messageReceived

public void messageReceived(String sender,
                            long sequence,
                            org.nustaq.offheap.bytez.Bytez b,
                            long off,
                            int len)

Description copied from interface: FCSubscriber

a message has been defragmented and received. This method is called directly in the packet receiving thread, so processing should be delegated to a worker or be extremely quick. else packet loss might occur. one can use 'Bytez.getArr(off, tmpBuf, 0, len);' to copy the message contents to a byte array 'tmpBuf'.

Specified by:

messageReceived in interface FCSubscriber

Overrides:

messageReceived in class ByteArraySubscriber

Parameters:

sender - - nodeId of sending process

sequence - - internal sequence number (of interest for unreliable variants)

b - - bytesource containing the message at off and with len

off - - offset of message

len - - len of message

messageReceived

public void messageReceived(String sender,
                            long sequence,
                            byte[] bytes,
                            int off,
                            int len)

note: this is not called in case decodeInReceiver is true or no dedicated thread is pressent. So take care when overriding

Specified by:

messageReceived in class ByteArraySubscriber

objectReceived

protected abstract void objectReceived(String sender,
                                       long sequence,
                                       Object msg)