hera.client

Class BlockTemplate

java.lang.Object

hera.client.BlockTemplate

All Implemented Interfaces:

BlockOperation, ChannelInjectable, ContextProviderInjectable

@ApiAudience.Private
 @ApiStability.Unstable
public class BlockTemplate
extends java.lang.Object
implements BlockOperation, ChannelInjectable, ContextProviderInjectable

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockBaseTemplate	blockBaseTemplate
protected ContextProvider	contextProvider
protected ExceptionConverter<RpcException>	exceptionConverter

Constructor Summary

Constructors

Constructor and Description
BlockTemplate()

Method Summary

Modifier and Type	Method and Description
Block	getBlock(BlockHash blockHash) Get block by hash.
Block	getBlock(long height) Get block by height.
BlockMetadata	getBlockMetadata(BlockHash blockHash) Get block meta data by hash.
BlockMetadata	getBlockMetadata(long height) Get block meta data by height.
java.util.List<BlockMetadata>	listBlockMetadatas(BlockHash blockHash, int size) Get list of block meta data of size backward starting from block for provided hash.
java.util.List<BlockMetadata>	listBlockMetadatas(long height, int size) Get list of block meta data of size backward starting from block for provided height.
void	setChannel(io.grpc.ManagedChannel channel)
void	setContextProvider(ContextProvider contextProvider)
Subscription<Block>	subscribeNewBlock(StreamObserver<Block> observer) Subscribe block stream which is triggered everytime new block is generated.
Subscription<BlockMetadata>	subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer) Subscribe block metadata stream which is triggered everytime new block is generated.

Methods inherited from class java.lang.Object

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

Field Detail

exceptionConverter

protected final ExceptionConverter<RpcException> exceptionConverter

blockBaseTemplate

protected BlockBaseTemplate blockBaseTemplate

contextProvider

protected ContextProvider contextProvider

Constructor Detail

BlockTemplate

public BlockTemplate()

Method Detail

setChannel

public void setChannel(io.grpc.ManagedChannel channel)

Specified by:

setChannel in interface ChannelInjectable

setContextProvider

public void setContextProvider(ContextProvider contextProvider)

Specified by:

setContextProvider in interface ContextProviderInjectable

getBlockMetadata

public BlockMetadata getBlockMetadata(BlockHash blockHash)

Description copied from interface: BlockOperation

Get block meta data by hash.

Specified by:

getBlockMetadata in interface BlockOperation

Parameters:

blockHash - block hash

Returns:

block meta data

getBlockMetadata

public BlockMetadata getBlockMetadata(long height)

Description copied from interface: BlockOperation

Get block meta data by height.

Specified by:

getBlockMetadata in interface BlockOperation

Parameters:

height - block's height

Returns:

block meta data

listBlockMetadatas

public java.util.List<BlockMetadata> listBlockMetadatas(BlockHash blockHash,
                                                        int size)

Description copied from interface: BlockOperation

Get list of block meta data of size backward starting from block for provided hash.

Specified by:

listBlockMetadatas in interface BlockOperation

Parameters:

blockHash - block hash

size - block list size whose upper bound is 1000

Returns:

list of block meta data

listBlockMetadatas

public java.util.List<BlockMetadata> listBlockMetadatas(long height,
                                                        int size)

Description copied from interface: BlockOperation

Get list of block meta data of size backward starting from block for provided height.

Specified by:

listBlockMetadatas in interface BlockOperation

Parameters:

height - block's height

size - block list size whose upper bound is 1000

Returns:

list of block meta data

getBlock

public Block getBlock(BlockHash blockHash)

Description copied from interface: BlockOperation

Get block by hash.

Specified by:

getBlock in interface BlockOperation

Parameters:

blockHash - block hash

Returns:

block

getBlock

public Block getBlock(long height)

Description copied from interface: BlockOperation

Get block by height.

Specified by:

getBlock in interface BlockOperation

Parameters:

height - block's height

Returns:

block

subscribeNewBlockMetadata

public Subscription<BlockMetadata> subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer)

Description copied from interface: BlockOperation

Subscribe block metadata stream which is triggered everytime new block is generated.

Specified by:

subscribeNewBlockMetadata in interface BlockOperation

Parameters:

observer - a stream observer which is invoked on new block metadata

Returns:

a block subscription

subscribeNewBlock

public Subscription<Block> subscribeNewBlock(StreamObserver<Block> observer)

Description copied from interface: BlockOperation

Subscribe block stream which is triggered everytime new block is generated.

Specified by:

subscribeNewBlock in interface BlockOperation

Parameters:

observer - a stream observer which is invoked on new block

Returns:

a block subscription