net.openhft.chronicle.wire

Class HashWire

java.lang.Object

net.openhft.chronicle.wire.HashWire

All Implemented Interfaces:

net.openhft.chronicle.bytes.BytesComment, MarshallableOut, WireCommon, WireOut

public class HashWire
extends Object
implements WireOut, net.openhft.chronicle.bytes.BytesComment

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.wire.MarshallableOut

MarshallableOut.Padding

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WireOut

DEFAULT_SAFE_LENGTH, TRY_WRITE_HEADER_FAILED

Constructor Summary

Constructors

Constructor and Description
HashWire()

Method Summary

Modifier and Type	Method and Description
WireOut	addPadding(int paddingToAdd)
net.openhft.chronicle.bytes.Bytes<?>	bytes()
net.openhft.chronicle.bytes.BytesComment<?>	bytesComment()
net.openhft.chronicle.core.pool.ClassLookup	classLookup()
void	classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup) Define how classes should be looked up.
void	clear() This will reset the positions and the header number.
void	endEvent()
boolean	endUse() Check the Wire was not used by another thread.
long	enterHeader(int safeLength)
ValueOut	getValueOut() Obtain the value out
int	hash32()
static int	hash32(Object value)
static int	hash32(WriteMarshallable value)
long	hash64()
static long	hash64(Object value)
static long	hash64(WriteMarshallable value)
long	headerNumber()
WireOut	headerNumber(long headerNumber)
boolean	isTextWire()
net.openhft.chronicle.core.values.BooleanValue	newBooleanReference()
net.openhft.chronicle.core.values.IntValue	newIntReference()
net.openhft.chronicle.core.values.LongArrayValues	newLongArrayReference()
net.openhft.chronicle.core.values.LongValue	newLongReference()
ObjectOutput	objectOutput()
Object	parent() Obtain the parent class of this wire if there is one
void	parent(Object parent) Assign a parent object to this wire for later retrieval.
net.openhft.chronicle.threads.Pauser	pauser()
void	pauser(net.openhft.chronicle.threads.Pauser pauser)
void	startEvent() Start an event object, mostly for internal use.
boolean	startUse() Used to check that the wire is being used by only one thread
void	updateFirstHeader() update the first header after writing.
void	updateHeader(long position, boolean metaData, int expectedHeader)
ValueOut	write() Write an empty filed marker
ValueOut	write(CharSequence name)
ValueOut	write(WireKey key) Write a key for wires that support fields.
WireOut	writeComment(CharSequence s)
void	writeEndOfWire(long timeout, TimeUnit timeUnit, long lastPosition) Write the end of wire marker, unless one is already written.
ValueOut	writeEvent(Class ignored, Object eventKey)
boolean	writeFirstHeader() Start the first header, if there is none This will increment the headerNumber as appropriate if successful
long	writeHeaderOfUnknownLength(int safeLength, long timeout, TimeUnit timeUnit, net.openhft.chronicle.core.values.LongValue lastPosition, Sequence sequence) Write a message of unknown length, handling timeouts and the end of wire marker.
DocumentContext	writingDocument(boolean metaData) This will increment the headerNumber as appropriate if successful

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.wire.WireOut

dropDefault, padToCacheAlign, updateHeader, writeAlignTo, writeAllAsMap, writeDocument, writeEventId, writeEventName, writeEventName, writeHeader, writeHeaderOfUnknownLength, writeNotCompleteDocument, writingDocument

Methods inherited from interface net.openhft.chronicle.wire.WireCommon

newTwoLongReference, notCompleteIsNotPresent, notCompleteIsNotPresent

Methods inherited from interface net.openhft.chronicle.wire.MarshallableOut

methodWriter, methodWriter, methodWriterBuilder, padToCacheAlignMode, recordHistory, writeBytes, writeDocument, writeDocument, writeMap, writeMessage, writeText

Methods inherited from interface net.openhft.chronicle.bytes.BytesComment

comment, indent, retainsComments

Constructor Detail

HashWire

public HashWire()

Method Detail

hash64

public static long hash64(WriteMarshallable value)

hash64

public static long hash64(Object value)

hash32

public static int hash32(WriteMarshallable value)

hash32

public static int hash32(Object value)

classLookup

public void classLookup(net.openhft.chronicle.core.pool.ClassLookup classLookup)

Description copied from interface: WireCommon

Define how classes should be looked up.

Specified by:

classLookup in interface WireCommon

Parameters:

classLookup - to use

classLookup

public net.openhft.chronicle.core.pool.ClassLookup classLookup()

Specified by:

classLookup in interface WireCommon

Returns:

the current implementation for looking up classes.

clear

public void clear()

Description copied from interface: WireOut

This will reset the positions and the header number.

Specified by:

clear in interface WireCommon

Specified by:

clear in interface WireOut

parent

@Nullable
public Object parent()

Description copied from interface: WireCommon

Obtain the parent class of this wire if there is one

Specified by:

parent in interface WireCommon

Returns:

the parent or null if none was assigned.

parent

public void parent(Object parent)

Description copied from interface: WireCommon

Assign a parent object to this wire for later retrieval.

Specified by:

parent in interface WireCommon

Parameters:

parent - to set, or null if there isn't one.

startUse

public boolean startUse()

Description copied from interface: WireCommon

Used to check that the wire is being used by only one thread

Specified by:

startUse in interface WireCommon

Returns:

true always, so it can be used in an assert line

endUse

public boolean endUse()

Description copied from interface: WireCommon

Check the Wire was not used by another thread.

Specified by:

endUse in interface WireCommon

Returns:

true always, so it can be used in an assert line

hash64

public long hash64()

hash32

public int hash32()

write

@NotNull
public ValueOut write()

Description copied from interface: WireOut

Write an empty filed marker

Specified by:

write in interface WireOut

write

@NotNull
public ValueOut write(@NotNull
                               WireKey key)

Description copied from interface: WireOut

Write a key for wires that support fields.

Specified by:

write in interface WireOut

write

@NotNull
public ValueOut write(@NotNull
                               CharSequence name)

Specified by:

write in interface WireOut

writeEvent

@NotNull
public ValueOut writeEvent(Class ignored,
                                    @NotNull
                                    Object eventKey)

Specified by:

writeEvent in interface WireOut

startEvent

public void startEvent()

Description copied from interface: WireOut

Start an event object, mostly for internal use.

Specified by:

startEvent in interface WireOut

endEvent

public void endEvent()

Specified by:

endEvent in interface WireOut

getValueOut

@NotNull
public ValueOut getValueOut()

Description copied from interface: WireOut

Obtain the value out

Specified by:

getValueOut in interface WireOut

objectOutput

@NotNull
public ObjectOutput objectOutput()

Specified by:

objectOutput in interface WireOut

writeComment

@NotNull
public WireOut writeComment(CharSequence s)

Specified by:

writeComment in interface WireOut

addPadding

@NotNull
public WireOut addPadding(int paddingToAdd)

Specified by:

addPadding in interface WireOut

headerNumber

@NotNull
public WireOut headerNumber(long headerNumber)

Specified by:

headerNumber in interface WireCommon

headerNumber

public long headerNumber()

Specified by:

headerNumber in interface WireCommon

writingDocument

@NotNull
public DocumentContext writingDocument(boolean metaData)

Description copied from interface: WireOut

This will increment the headerNumber as appropriate if successful

Specified by:

writingDocument in interface MarshallableOut

Specified by:

writingDocument in interface WireOut

Parameters:

metaData - if true the document context will be used for writing meta data, otherwise data

Returns:

a document context used for witting

writeHeaderOfUnknownLength

public long writeHeaderOfUnknownLength(int safeLength,
                                       long timeout,
                                       TimeUnit timeUnit,
                                       @Nullable
                                       net.openhft.chronicle.core.values.LongValue lastPosition,
                                       Sequence sequence)

Description copied from interface: WireOut

Write a message of unknown length, handling timeouts and the end of wire marker. This will increment the headerNumber as appropriate if successful

Specified by:

writeHeaderOfUnknownLength in interface WireOut

timeout - throw a TimeoutException if the header could not be written in this time.

timeUnit - of the timeOut

lastPosition - the last known position

Returns:

the position of the start of the header

enterHeader

public long enterHeader(int safeLength)

Specified by:

enterHeader in interface WireOut

updateHeader

public void updateHeader(long position,
                         boolean metaData,
                         int expectedHeader)

Specified by:

updateHeader in interface WireOut

writeFirstHeader

public boolean writeFirstHeader()

Description copied from interface: WireOut

Start the first header, if there is none This will increment the headerNumber as appropriate if successful

Note: the file might contain other data and the caller has to check this.

Specified by:

writeFirstHeader in interface WireOut

Returns:

true if the header needs to be written, false if there is a data already

updateFirstHeader

public void updateFirstHeader()

Description copied from interface: WireOut

update the first header after writing.

Specified by:

updateFirstHeader in interface WireOut

writeEndOfWire

public void writeEndOfWire(long timeout,
                           TimeUnit timeUnit,
                           long lastPosition)

Description copied from interface: WireOut

Write the end of wire marker, unless one is already written. This will increment the headerNumber as appropriate if successful

Specified by:

writeEndOfWire in interface WireOut

Parameters:

timeout - throw TimeoutException if it could not write the marker in time.

timeUnit - of the timeout

lastPosition - the end of the wire

bytes

@NotNull
public net.openhft.chronicle.bytes.Bytes<?> bytes()

Specified by:

bytes in interface WireCommon

Returns:

the underlying Bytes

bytesComment

public net.openhft.chronicle.bytes.BytesComment<?> bytesComment()

Specified by:

bytesComment in interface WireCommon

Returns:

the bytes90 but only for comment

newIntReference

@NotNull
public net.openhft.chronicle.core.values.IntValue newIntReference()

Specified by:

newIntReference in interface WireCommon

Returns:

an IntValue which appropriate for this wire.

newLongReference

@NotNull
public net.openhft.chronicle.core.values.LongValue newLongReference()

Specified by:

newLongReference in interface WireCommon

Returns:

a LongValue which appropriate for this wire.

newBooleanReference

@NotNull
public net.openhft.chronicle.core.values.BooleanValue newBooleanReference()

Specified by:

newBooleanReference in interface WireCommon

Returns:

a BooleanValue which appropriate for this wire.

isTextWire

public boolean isTextWire()

Specified by:

isTextWire in interface WireCommon

newLongArrayReference

@NotNull
public net.openhft.chronicle.core.values.LongArrayValues newLongArrayReference()

Specified by:

newLongArrayReference in interface WireCommon

Returns:

a LongArrayValue which appropriate for this wire.

pauser

@NotNull
public net.openhft.chronicle.threads.Pauser pauser()

Specified by:

pauser in interface WireCommon

Returns:

pauser used.

pauser

public void pauser(net.openhft.chronicle.threads.Pauser pauser)

Specified by:

pauser in interface WireCommon

Parameters:

pauser - to use for blocking operations.