org.jgroups.blocks.Marshaller Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

package org.jgroups.blocks;

import java.io.DataInput;
import java.io.DataOutput;

/**
 * Performs serialization and de-serialization of RPC call arguments and return values (including exceptions)
 * @author Bela Ban
 * @since  2.x, 4.0
 */
public interface Marshaller {

    /**
     * Estimates the number of bytes needed to serialize an object to an output stream. This is used to create an output
     * stream with an initial capacity, so it does not need to be exact. However, if the estimated size is much smaller than
     * the actual size needed by the arguments, the output stream's buffer will have to be copied, possibly multiple times.
     * @param arg the object; argument to an RPC, or return value (could also be an exception). May be null (e.g. an
     *           RPC returning void)
     * @return the estimated size
     */
    default int estimatedSize(Object arg) {
        return arg == null? 2: 50;
    }

    /**
     * Serializes an object to an output stream
     * @param obj the object to be serialized
     * @param out the output stream, created taking {@link #estimatedSize(Object)} into account
     * @throws Exception thrown if serialization failed
     */
    void objectToStream(Object obj, DataOutput out) throws Exception;

    /**
     * Creates an object from a stream
     * @param in the input stream
     * @return an object read from the input stream
     * @throws Exception thrown if deserialization failed
     */
    Object objectFromStream(DataInput in) throws Exception;
}