org.apache.hadoop.hbase.ipc

Class IPCUtil

java.lang.Object

org.apache.hadoop.hbase.ipc.IPCUtil

@InterfaceAudience.Private
public class IPCUtil
extends Object

Utility to help ipc'ing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPCUtil.CellScannerButNoCodecException Thrown if a cellscanner but no codec to encode it with.

Field Summary

Fields

Modifier and Type	Field and Description
static Log	LOG

Constructor Summary

Constructors

Constructor and Description
IPCUtil(Configuration conf)

Method Summary

Modifier and Type	Method and Description
ByteBuffer	buildCellBlock(Codec codec, CompressionCodec compressor, CellScanner cellScanner) Puts CellScanner Cells into a cell block using passed in codec and/or compressor.
ByteBuffer	buildCellBlock(Codec codec, CompressionCodec compressor, CellScanner cellScanner, BoundedByteBufferPool pool) Puts CellScanner Cells into a cell block using passed in codec and/or compressor.
CellScanner	createCellScanner(Codec codec, CompressionCodec compressor, byte[] cellBlock)
CellScanner	createCellScanner(Codec codec, CompressionCodec compressor, byte[] cellBlock, int offset, int length)
static ByteBuffer	getDelimitedMessageAsByteBuffer(Message m)
static int	getTotalSizeWhenWrittenDelimited(Message... messages)
static void	readChunked(DataInput in, byte[] dest, int offset, int len) Read in chunks of 8K (HBASE-7239)
static int	write(OutputStream dos, Message header, Message param, ByteBuffer cellBlock) Write out header, param, and cell block if there is one.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Log LOG

Constructor Detail

IPCUtil

public IPCUtil(Configuration conf)

Method Detail

buildCellBlock

public ByteBuffer buildCellBlock(Codec codec,
                                 CompressionCodec compressor,
                                 CellScanner cellScanner)
                          throws IOException

Puts CellScanner Cells into a cell block using passed in codec and/or compressor.

Parameters:

codec -

compressor -

cellScanner -

Returns:

Null or byte buffer filled with a cellblock filled with passed-in Cells encoded using passed in codec and/or compressor; the returned buffer has been flipped and is ready for reading. Use limit to find total size.

Throws:

IOException

buildCellBlock

public ByteBuffer buildCellBlock(Codec codec,
                                 CompressionCodec compressor,
                                 CellScanner cellScanner,
                                 BoundedByteBufferPool pool)
                          throws IOException

Puts CellScanner Cells into a cell block using passed in codec and/or compressor.

Parameters:

codec -

compressor -

cellScanner -

pool - Pool of ByteBuffers to make use of. Can be null and then we'll allocate our own ByteBuffer.

Returns:

Null or byte buffer filled with a cellblock filled with passed-in Cells encoded using passed in codec and/or compressor; the returned buffer has been flipped and is ready for reading. Use limit to find total size. If pool was not null, then this returned ByteBuffer came from there and should be returned to the pool when done.

Throws:

IOException

createCellScanner

public CellScanner createCellScanner(Codec codec,
                                     CompressionCodec compressor,
                                     byte[] cellBlock)
                              throws IOException

Parameters:

codec -

cellBlock -

Returns:

CellScanner to work against the content of cellBlock

Throws:

IOException

createCellScanner

public CellScanner createCellScanner(Codec codec,
                                     CompressionCodec compressor,
                                     byte[] cellBlock,
                                     int offset,
                                     int length)
                              throws IOException

Parameters:

codec -

cellBlock -

offset -

length -

Returns:

CellScanner to work against the content of cellBlock

Throws:

IOException

getDelimitedMessageAsByteBuffer

public static ByteBuffer getDelimitedMessageAsByteBuffer(Message m)
                                                  throws IOException

Parameters:

m - Message to serialize delimited; i.e. w/ a vint of its size preceeding its serialization.

Returns:

The passed in Message serialized with delimiter. Return null if m is null

Throws:

IOException

write

public static int write(OutputStream dos,
                        Message header,
                        Message param,
                        ByteBuffer cellBlock)
                 throws IOException

Write out header, param, and cell block if there is one.

Parameters:

dos -

header -

param -

cellBlock -

Returns:

Total number of bytes written.

Throws:

IOException

readChunked

public static void readChunked(DataInput in,
                               byte[] dest,
                               int offset,
                               int len)
                        throws IOException

Read in chunks of 8K (HBASE-7239)

Parameters:

in -

dest -

offset -

len -

Throws:

IOException

getTotalSizeWhenWrittenDelimited

public static int getTotalSizeWhenWrittenDelimited(Message... messages)

Returns:

Size on the wire when the two messages are written with writeDelimitedTo