org.neo4j.causalclustering.messaging.marshalling

Interface ChannelMarshal<STATE>

Type Parameters:

STATE - The class of objects supported by this marshal

All Known Subinterfaces:

StateMarshal<STATE>

All Known Implementing Classes:

ClusterId.Marshal, CoreReplicatedContentMarshal, CoreSnapshot.Marshal, GlobalSessionTrackerState.Marshal, IdAllocationState.Marshal, LongIndexMarshal, MemberId.Marshal, MembershipEntry.Marshal, RaftCoreState.Marshal, RaftMembershipState.Marshal, ReplicatedLockTokenState.Marshal, SafeChannelMarshal, SafeStateMarshal, StoreIdMarshal, TermState.Marshal, VoteState.Marshal

public interface ChannelMarshal<STATE>

Implementations of this class perform marshalling (encoding/decoding) of STATE into/from a WritableChannel and a ReadableChannel respectively. N.B.: Implementations should prefer to extend SafeChannelMarshal to handle ReadPastEndException correctly.

Method Summary

Modifier and Type	Method and Description
void	marshal(STATE state, org.neo4j.storageengine.api.WritableChannel channel) Marshals the state into the channel.
STATE	unmarshal(org.neo4j.storageengine.api.ReadableChannel channel) Unmarshals an instance of STATE from channel.

Method Detail

marshal

void marshal(STATE state,
             org.neo4j.storageengine.api.WritableChannel channel)
      throws IOException

Marshals the state into the channel.

Throws:

IOException

unmarshal

STATE unmarshal(org.neo4j.storageengine.api.ReadableChannel channel)
         throws IOException,
                EndOfStreamException

Unmarshals an instance of STATE from channel. If the channel does not have enough bytes to fully read an instance then an EndOfStreamException must be thrown. N.B: The ReadableChannel is sort of broken in its implementation and throws ReadPastEndException which is a subclass of IOException and that is problematic since usually the case of reaching the end of a stream actually requires handling distinct from that of arbitrary IOExceptions. Although it was possible to catch that particular exception explicitly, you would not get compiler/IDE support for making that apparent.

Throws:

IOException

EndOfStreamException