org.jgroups.FragmentedMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgroups
Reliable cluster communication toolkit
There is a newer version: 5.4.1.Final
package org.jgroups;

import org.jgroups.util.ByteArrayDataOutputStream;
import org.jgroups.util.PartialOutputStream;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.function.Supplier;

/**
 * A message which refers to another message, but only marshals ({@link org.jgroups.util.Streamable#writeTo(DataOutput)})
 * a part of the original message, starting at a given {@link #offset} and marshalling only {@link #length} bytes.
 * 

 * The marshalling is done using {@link org.jgroups.util.PartialOutputStream}.

 * Used by {@link org.jgroups.protocols.FRAG4}.
 *
 * @author Bela Ban
 * @since  5.0
 */
public class FragmentedMessage extends BytesMessage { // we need the superclass' byte array for de-serialization only
    protected Message original_msg;

    public FragmentedMessage() { // for de-serialization
    }

    public FragmentedMessage(Message original_msg, int off, int len) {
        this.original_msg=original_msg;
        this.offset=off;
        this.length=len;
    }

    public Message           getOriginalMessage() {return original_msg;}
    public short             getType()            {return Message.FRAG_MSG;}
    public boolean           hasArray()           {return false;}
    public boolean           hasPayload()         {return true;}
    public Supplier create()             {return FragmentedMessage::new;}
    protected int            sizeOfPayload()      {return Global.INT_SIZE + length;}

    @Override
    protected Message copyPayload(Message copy) {
        FragmentedMessage msg=(FragmentedMessage)super.copyPayload(copy);
        msg.offset=this.offset;
        msg.length=this.length;
        msg.original_msg=this.original_msg;
        return msg;
    }

    public void writePayload(DataOutput out) throws IOException {
        ByteArrayDataOutputStream bos=out instanceof ByteArrayDataOutputStream? (ByteArrayDataOutputStream)out : null;
        int size_pos=bos != null? bos.position() : -1;
        out.writeInt(length);
        PartialOutputStream pos=new PartialOutputStream(out, offset, length);

        int prev_pos=bos != null? bos.position() : -1;
        original_msg.writeTo(pos);
        int last_pos=bos != null? bos.position() : -1;
        int written=last_pos-prev_pos;

        // if we have a ByteArrayDataOutputStream *and* the number of bytes written doesn't correspond with the length,
        // then fix the length in the output stream (https://issues.redhat.com/browse/JGRP-2289)
        if(bos != null && written != length) {
            int current_pos=bos.position();
            bos.position(size_pos);
            bos.writeInt(written);
            bos.position(current_pos);
        }
    }

    public void readPayload(DataInput in) throws IOException {
        this.length=in.readInt();
        if(this.length > 0) {
            this.array=new byte[this.length];
            in.readFully(this.array);
        }
    }


    public String toString() {
        return String.format("%s [off=%d len=%d] (original msg: %s)",
                             getClass().getSimpleName(), offset, length, original_msg);
    }


    protected  T createMessage() {
        return (T)new FragmentedMessage();
    }
}