Package org.jgroups.protocols
Class PrioHeader
java.lang.Object
org.jgroups.Header
org.jgroups.protocols.PrioHeader
- All Implemented Interfaces:
Streamable
This Header class is used in conjunction with the PRIO protocol to prioritize message sending/receiving
Priority values are from 0 to 255 where 0 is the highest priority
Example of setting a message priority:
// Create a message to send to everyone
Message message = new Message( null, null, messagePayload );
// Add the priority protocol header
PrioHeader header = new PrioHeader( 1 );
short protocolId = ClassConfigurator.getProtocolId(PRIO.class);
message.putHeader( protocolId, header);
- Author:
- Michael Earl
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbytevoidreadFrom(DataInputStream instream) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closedvoidsetPriority(byte priority) intsize()To be implemented by subclasses.toString()voidwriteTo(DataOutputStream outstream) Write the entire state of the current object (including superclasses) to outstream.
-
Constructor Details
-
PrioHeader
public PrioHeader() -
PrioHeader
public PrioHeader(byte priority)
-
-
Method Details
-
getPriority
public byte getPriority() -
setPriority
public void setPriority(byte priority) -
size
public int size()Description copied from class:HeaderTo be implemented by subclasses. Return the size of this object for the serialized version of it. I.e. how many bytes this object takes when flattened into a buffer. This may be different for each instance, or can be the same. This may also just be an estimation. E.g. FRAG uses it on Message to determine whether or not to fragment the message. Fragmentation itself will be accurate, because the entire message will actually be serialized into a byte buffer, so we can determine the exact size. -
writeTo
Description copied from interface:StreamableWrite the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed- Throws:
IOException
-
readFrom
public void readFrom(DataInputStream instream) throws IOException, IllegalAccessException, InstantiationException Description copied from interface:StreamableRead the state of the current object (including superclasses) from instream Note that the input stream must not be closed -
toString
-