fulmine.protocol.specification
Interface IFrameReader

All Known Implementing Classes:

FrameReader

public interface IFrameReader

Reads fulmine delta (FD) protocol frames.

Please refer to the "Fulmine Delta Transmission Protocol" specification for a complete description of the fulmine serialisation technique.

Author:

Ramon Servadei

See Also:

IFrameConstants

Method Summary

IAddressable	getRemoteContainerDetailsFromFrame(byte[] frame, String remoteContextIdentity) Get the identity, type and domain of the container in the frame
IContainer	getRemoteContainerForFrame(byte[] frame, String remoteContextIdentity, IFrameworkContext context) Get the remote container for the frame.
IContainer	read(byte[] frame, String remoteContextIdentity, IFrameworkContext context) Reads an FD frame holding the state of a container.

Method Detail

read

IContainer read(byte[] frame,
                String remoteContextIdentity,
                IFrameworkContext context)

Reads an FD frame holding the state of a container. The container to process the frame is located or created by this method.

Parameters:

frame - the byte[] holding the wire state of a container.

remoteContextIdentity - the identity of the remote context this frame is from

context - the context to use to create the remote IContainer

Returns:

the remote IContainer with the state in the frame applied

getRemoteContainerForFrame

IContainer getRemoteContainerForFrame(byte[] frame,
                                      String remoteContextIdentity,
                                      IFrameworkContext context)

Get the remote container for the frame. The container to process the frame is located or created by this method.

Parameters:

frame - the byte[] holding the wire state of a container.

remoteContextIdentity - the identity of the remote context this frame is from

context - the context to use to create the remote IContainer

Returns:

the remote IContainer for the frame.

getRemoteContainerDetailsFromFrame

IAddressable getRemoteContainerDetailsFromFrame(byte[] frame,
                                                String remoteContextIdentity)

Get the identity, type and domain of the container in the frame

Parameters:

frame - the byte[] holding the wire state of a container.

remoteContextIdentity - the identity of the remote context this frame is from

Returns:

an IAddressable object identifying the identity, type and domain of the container this frame is for