HashWire (OpenHFT/Chronicle-Wire 1.6.0 API)

java.lang.Object
- net.openhft.chronicle.wire.HashWire

All Implemented Interfaces:

WireCommon, WireOut
```
public class HashWire
extends Object
implements WireOut
```
Created by peter.lawrey on 05/02/2016.

Constructor Summary

Constructors
Constructor and Description

HashWire()

Constructors
Constructor and Description
`HashWire()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WireOut`	`addPadding(int paddingToAdd)`
`net.openhft.chronicle.bytes.Bytes<?>`	`bytes()`
`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.
`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)`
`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 wrie is being used by only one thread
`void`	`updateFirstHeader()` update the first header after writing.
`void`	`updateHeader(int length, long position, boolean metaData)` Change the header from NOT_COMPLETE \| length to metaData * META_DATA \| length.
`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)` 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`	`writeHeader(int length, long timeout, TimeUnit timeUnit)` Write a message of a known 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
updateHeader, writeAlignTo, writeDocument, writeEventName, writeEventName, writeHeader, writeNotCompleteDocument

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

- 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
```
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 wrie 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(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(CharSequence name)
```
    Specified by:
    
    write in interface WireOut
  - writeEvent
```
public ValueOut writeEvent(Class ignored,
                           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
```
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
```
public WireOut headerNumber(long headerNumber)
```
    Specified by:
    
    headerNumber in interface WireOut
  - headerNumber
```
public long headerNumber()
```
    Specified by:
    
    headerNumber in interface WireOut
  - writingDocument
```
public DocumentContext writingDocument(boolean metaData)
```
    Description copied from interface: WireOut
    
    This will increment the headerNumber as appropriate if successful
    
    Specified by:
    
    writingDocument in interface WireOut
    
    Returns:
  - writeHeader
```
public long writeHeader(int length,
                        long timeout,
                        TimeUnit timeUnit)
                 throws TimeoutException,
                        EOFException
```
    Description copied from interface: WireOut
    
    Write a message of a known length, handling timeouts and the end of wire marker. This will increment the headerNumber as appropriate if successful
    
    Specified by:
    
    writeHeader in interface WireOut
    
    Parameters:
    
    length - the maximum length of the message.
    
    timeout - throw a TimeoutException if the header could not be written in this time.
    
    timeUnit - of the timeOut
    
    Returns:
    
    the position of the start of the header
    
    Throws:
    
    TimeoutException - the underlying pauser timed out.
    
    EOFException - the end of wire marker was reached.
  - updateHeader
```
public void updateHeader(int length,
                         long position,
                         boolean metaData)
                  throws StreamCorruptedException
```
    Description copied from interface: WireOut
    
    Change the header from NOT_COMPLETE | length to metaData * META_DATA | length.
    
    Specified by:
    
    updateHeader in interface WireOut
    
    Parameters:
    
    length - provided to make the header, note this can be larger than the message actually used.
    
    position - returned by writeHeader
    
    metaData - whether the message is meta data or not.
    
    Throws:
    
    StreamCorruptedException
  - 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)
                    throws TimeoutException
```
    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
    
    Throws:
    
    TimeoutException - timeout exceeded.
  - bytes
```
@NotNull
public net.openhft.chronicle.bytes.Bytes<?> bytes()
```
    Specified by:
    
    bytes in interface WireCommon
    
    Returns:
    
    the underlying Bytes
  - 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.
  - 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
```
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.

Class HashWire

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Constructor Detail

HashWire

Method Detail

hash64

hash64

hash32

hash32

classLookup

classLookup

clear

parent

parent

startUse

endUse

hash64

hash32

write

write

write

writeEvent

startEvent

endEvent

getValueOut

objectOutput

writeComment

addPadding

headerNumber

headerNumber

writingDocument

writeHeader

updateHeader

writeFirstHeader

updateFirstHeader

writeEndOfWire

bytes

newIntReference

newLongReference

newLongArrayReference

pauser

pauser