com.peersafe.base.client

类 Client

java.lang.Object

com.peersafe.base.client.pubsub.Publisher<Client.events>

com.peersafe.base.client.Client

所有已实现的接口:

TransportEventHandler

直接已知子类:

MockPair.MockClient

public class Client
extends Publisher<Client.events>
implements TransportEventHandler

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	Client.events<T>
static interface	Client.OnChainsqlSubRet
static interface	Client.OnConnected
static interface	Client.OnContractEvent
static interface	Client.OnDisconnected
static interface	Client.OnLedgerClosed
static interface	Client.OnMessage
static interface	Client.OnPathFind
static interface	Client.OnReconnected
static interface	Client.OnReconnecting
static interface	Client.OnSendMessage
static interface	Client.OnStateChange
static interface	Client.OnSubscribed
static interface	Client.OnTBMessage
static interface	Client.OnTXMessage
static interface	Client.OnValidatedTransaction
static class	Client.ThrowingRunnable

从类继承的嵌套类/接口 com.peersafe.base.client.pubsub.Publisher

Publisher.Callback<T>, Publisher.ErrBack<T>

字段概要

字段

限定符和类型	字段和说明
protected Thread	clientThread See run(java.lang.Runnable)
boolean	connected
static Logger	logger
long	maintenanceSchedule
String	NAMEINDB
double	randomBugsFrequency When this is non 0, we randomly disconnect when trying to send messages See sendMessage(org.json.JSONObject)
protected TreeMap<Integer,Request>	requests
String	schemaID
int	SEQUENCE
ServerInfo	serverInfo
protected ScheduledExecutorService	service
SubscriptionManager	subscriptions

构造器概要

构造器

构造器和说明
Client(WebSocketTransport ws) Constructor

方法概要

限定符和类型	方法和说明
Account	accountFromSeed(String masterSeed) Request account information.
org.json.JSONObject	accountInfo(AccountID account) Request for account information.
AccountTxPager	accountTxPager(AccountID accountID) Request account transaction page.
Client	connect(String uri) After calling this method, all subsequent interaction with the api should be called via posting Runnable() run blocks to the Executor.
void	connect(String s, Client.OnConnected onConnected) Handler binders binder
Client	connect(String uri, String serverCertPath, String storePass)
org.json.JSONObject	contractCall(org.json.JSONObject obj) contractCall synchronously
void	contractCall(org.json.JSONObject obj, Publisher.Callback<org.json.JSONObject> cb) contractCall asynchronously
void	disconnect() Disconnect from websocket-url
void	disconnect(Client.OnDisconnected onDisconnected) Disconnect from current connection.
void	dispose() Release websocket connection.
void	doConnect(String uri) Connect.
void	doConnect(String uri, String serverCertPath, String storePass)
void	GetAccountLines(AccountID addy, Publisher.Callback<org.json.JSONObject> cb) Request for account_lines.
org.json.JSONObject	GetAccountLines(String address) GetAccountLines synchronously
org.json.JSONObject	getAccountTables(String address, boolean bGetDetail)
void	getAccountTables(String address, boolean bGetDetail, Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getBySqlAdmin(String sql)
void	getBySqlAdmin(String sql, Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getBySqlUser(String secret, String accountID, String sql)
void	getBySqlUser(String secret, String accountID, String sql, Publisher.Callback<org.json.JSONObject> cb)
void	getCrossChainTxs(String hash, int limit, boolean include, Publisher.Callback<org.json.JSONObject> cb) Request for transaction information.
org.json.JSONObject	getLedger(org.json.JSONObject option)
void	getLedger(org.json.JSONObject option, Publisher.Callback<org.json.JSONObject> cb) Request for ledger data.
org.json.JSONObject	getLedgerTxs(Integer ledgerSeq, boolean bIncludeSuccess, boolean bIncludefailure)
void	getLedgerTxs(Integer ledgerSeq, boolean bIncludeSuccess, boolean bIncludefailure, Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getLedgerVersion()
void	getLedgerVersion(Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getNameInDB(String owner, String tableName)
void	getNameInDB(String owner, String tableName, Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getPeers() Get peers
org.json.JSONObject	getSchemaInfo(String schemaID) Request for schema_info.
org.json.JSONObject	getSchemaList(org.json.JSONObject params) Get schema_list
org.json.JSONObject	getServerInfo() Get server_info
org.json.JSONObject	getTableAuth(String owner, String tableName, List<String> accounts)
void	getTableAuth(String owner, String tableName, List<String> accounts, Publisher.Callback<org.json.JSONObject> cb)
org.json.JSONObject	getTransaction(org.json.JSONObject txInfo) getTransaction synchronously
org.json.JSONObject	getTransaction(String hash) getTransaction synchronously
void	getTransaction(String hash, Publisher.Callback<org.json.JSONObject> cb) Request for a transaction's information.
org.json.JSONObject	getTransactionCount() Get transaction count on chain.
org.json.JSONObject	getTransactions(String address, int limit)
void	getTransactions(String address, int limit, org.json.JSONObject marker, Publisher.Callback<org.json.JSONObject> cb) Request for transaction information.
void	getTransactions(String address, int limit, Publisher.Callback<org.json.JSONObject> cb) Request for transaction information.
org.json.JSONObject	getUnlList() Get unl_list
org.json.JSONObject	getUserToken(String owner, String user, String name) Get user_token for table,if token got not null, it is a confidential table.
void	getUserToken(String owner, String user, String name, Publisher.Callback<org.json.JSONObject> cb)
static void	log(Level level, String fmt, Object... args) Log tools.
<T> Request	makeManagedRequest(Command cmd, Request.Manager<T> manager, Request.Builder<T> builder) Managed Requests API
Request	newRequest(Command cmd) Create a new request.
void	nextTickOrWhenConnected(Client.OnConnected onConnected) Trigger next tick or when connected.
void	nowOrWhenConnected(Client.OnConnected onConnected) Now or when connected trigger.
void	onConnected() Run when connected.
Client	onConnected(Client.OnConnected onConnected) Trigger when websocket connection succeed.
void	onConnecting(int attempt) Override method,default.
Client	onContractEvent(Client.OnContractEvent cb)
void	onDisconnected(boolean willReconnect) Run when disconnected.
Client	onDisconnected(Client.OnDisconnected cb) Trigger when websocket connection disconnected.
void	onError(Exception error) Override method,default.
protected void	onException(Exception e)
Client	onLedgerClosed(Client.OnLedgerClosed cb) Trigger when ledger closed
Client	OnMessage(Client.OnMessage cb) Trigger when websocket message received.
void	onMessage(org.json.JSONObject msg) This is to ensure we run everything on clientThread
void	onMessageInClientThread(org.json.JSONObject msg) Client message thread.
Client	onReconnected(Client.OnReconnected cb) Trigger when reconnect to a server succeed.
Client	onReconnecting(Client.OnReconnecting cb) Trigger when reconnecting to a server begins.
Client	OnSubChainsqlRet(Client.OnChainsqlSubRet cb)
Client	OnTBMessage(Client.OnTBMessage cb) Trigger when transaction related to a subscribed table validate_success or db_success.
void	onTransactionResult(TransactionResult tr) Transaction returned.
Client	OnTXMessage(Client.OnTXMessage cb) Trigger when a subscribed transaction validate_success or db_success.
Client	onValidatedTransaction(Client.OnValidatedTransaction cb) Trigger when a transaction validated.
static org.json.JSONObject	parseJSON(String s) JSON String to JSONObject.
Request	ping() Request ping.
protected void	prepareExecutor()
static String	prettyJSON(org.json.JSONObject object) JSON object to String.
void	reconnect() Reconnect when disconnected.
Request	requestBookOffers(Issue get, Issue pay) Request for book offers.
void	requestBookOffers(Number ledger_index, Issue get, Issue pay, Request.Manager<ArrayList<Offer>> cb) Request for book_offers.
void	requestLedgerEntry(Hash256 index, Number ledger_index, Request.Manager<LedgerEntry> cb) Request for a ledger_entry.
void	resubscribeStreams()
void	run(Runnable runnable) Run a task.
void	schedule(long ms, Runnable runnable) Start a scheduled task.
org.json.JSONObject	select(String secret, AccountID account, AccountID owner, String name, String raw, Publisher.Callback<org.json.JSONObject> cb) Select data from chain.
void	sendRequest(Request request) Send a request message.
static void	shutdown()
Request	submit(String tx_blob, boolean fail_hard) Submit a transaction
void	subscribe(org.json.JSONObject subscription)
Request	subscribeAccount(AccountID... accounts) Subscribe for account.
Request	subscribeBookOffers(Issue get, Issue pay) Request for book-offers.
org.json.JSONObject	tablePrepare(org.json.JSONObject txjson) Prepare for a transaction for : filling in NameInDB field, filling in CheckHash field for StrictMode
Client	transactionSubscriptionManager(TransactionSubscriptionManager transactionSubscriptionManager)
void	unsubscribe(org.json.JSONObject subscription)
Request	unsubscribeAccount(AccountID... accounts)
void	unsubscribeStreams()
void	whenConnected(boolean nextTick, Client.OnConnected onConnected) Trigger when connected.

从类继承的方法 com.peersafe.base.client.pubsub.Publisher

clearAllListeners, emit, execute, on, on, once, once, removeListener

从类继承的方法 java.lang.Object

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

字段详细资料

logger

public static final Logger logger

randomBugsFrequency

public double randomBugsFrequency

When this is non 0, we randomly disconnect when trying to send messages See sendMessage(org.json.JSONObject)

service

protected ScheduledExecutorService service

clientThread

protected Thread clientThread

See run(java.lang.Runnable)

requests

protected TreeMap<Integer,Request> requests

maintenanceSchedule

public long maintenanceSchedule

SEQUENCE

public int SEQUENCE

NAMEINDB

public String NAMEINDB

connected

public boolean connected

serverInfo

public ServerInfo serverInfo

subscriptions

public SubscriptionManager subscriptions

schemaID

public String schemaID

构造器详细资料

Client

public Client(WebSocketTransport ws)

Constructor

参数:

ws - Websocket implementation.

方法详细资料

onValidatedTransaction

public Client onValidatedTransaction(Client.OnValidatedTransaction cb)

Trigger when a transaction validated.

参数:

cb - Callback

返回:

This.

onLedgerClosed

public Client onLedgerClosed(Client.OnLedgerClosed cb)

Trigger when ledger closed

参数:

cb - Callback

返回:

This.

OnTBMessage

public Client OnTBMessage(Client.OnTBMessage cb)

Trigger when transaction related to a subscribed table validate_success or db_success.

参数:

cb - Callback

返回:

This.

OnSubChainsqlRet

public Client OnSubChainsqlRet(Client.OnChainsqlSubRet cb)

OnTXMessage

public Client OnTXMessage(Client.OnTXMessage cb)

Trigger when a subscribed transaction validate_success or db_success.

参数:

cb - Callback

返回:

This.

OnMessage

public Client OnMessage(Client.OnMessage cb)

Trigger when websocket message received.

参数:

cb - Callback

返回:

This.

onReconnecting

public Client onReconnecting(Client.OnReconnecting cb)

Trigger when reconnecting to a server begins.

参数:

cb - Callback

返回:

This.

onReconnected

public Client onReconnected(Client.OnReconnected cb)

Trigger when reconnect to a server succeed.

参数:

cb - Callback

返回:

This.

onConnected

public Client onConnected(Client.OnConnected onConnected)

Trigger when websocket connection succeed.

参数:

onConnected - Callback

返回:

This.

onDisconnected

public Client onDisconnected(Client.OnDisconnected cb)

Trigger when websocket connection disconnected.

参数:

cb - Callback.

返回:

This.

onContractEvent

public Client onContractEvent(Client.OnContractEvent cb)

shutdown

public static void shutdown()

transactionSubscriptionManager

public Client transactionSubscriptionManager(TransactionSubscriptionManager transactionSubscriptionManager)

参数:

transactionSubscriptionManager - Subscribe manager.

返回:

Self.

log

public static void log(Level level,
                       String fmt,
                       Object... args)

Log tools.

参数:

level - Log level.

fmt - Format.

args - Args.

prettyJSON

public static String prettyJSON(org.json.JSONObject object)

JSON object to String.

参数:

object - JSONObject.

返回:

JSON String.

parseJSON

public static org.json.JSONObject parseJSON(String s)

JSON String to JSONObject.

参数:

s - JSON String.

返回:

JSONObject.

connect

public Client connect(String uri)

After calling this method, all subsequent interaction with the api should be called via posting Runnable() run blocks to the Executor. Essentially, all ripple-lib-java api interaction should happen on the one thread.

参数:

uri - Websocket uri.

返回:

Self.

另请参阅:

onMessage(org.json.JSONObject)

connect

public Client connect(String uri,
                      String serverCertPath,
                      String storePass)

doConnect

public void doConnect(String uri)

Connect.

参数:

uri - Connect uri.

doConnect

public void doConnect(String uri,
                      String serverCertPath,
                      String storePass)
               throws Exception

抛出:

Exception

disconnect

public void disconnect()

Disconnect from websocket-url

reconnect

public void reconnect()

Reconnect when disconnected.

connect

public void connect(String s,
                    Client.OnConnected onConnected)

Handler binders binder

参数:

s - Url.

onConnected - Callback.

disconnect

public void disconnect(Client.OnDisconnected onDisconnected)

Disconnect from current connection.

参数:

onDisconnected - Callback.

whenConnected

public void whenConnected(boolean nextTick,
                          Client.OnConnected onConnected)

Trigger when connected.

参数:

nextTick - Next tick trigger callback.

onConnected - Callback.

nowOrWhenConnected

public void nowOrWhenConnected(Client.OnConnected onConnected)

Now or when connected trigger.

参数:

onConnected - Callback.

nextTickOrWhenConnected

public void nextTickOrWhenConnected(Client.OnConnected onConnected)

Trigger next tick or when connected.

参数:

onConnected - Callback.

dispose

public void dispose()

Release websocket connection.

run

public void run(Runnable runnable)

Run a task.

参数:

runnable - Thread object.

schedule

public void schedule(long ms,
                     Runnable runnable)

Start a scheduled task.

参数:

ms - Milliseconds.

runnable - Runnable object.

prepareExecutor

protected void prepareExecutor()

onException

protected void onException(Exception e)

onMessage

public void onMessage(org.json.JSONObject msg)

This is to ensure we run everything on clientThread

指定者:

onMessage 在接口中 TransportEventHandler

onConnecting

public void onConnecting(int attempt)

Override method,default.

指定者:

onConnecting 在接口中 TransportEventHandler

onError

public void onError(Exception error)

Override method,default.

指定者:

onError 在接口中 TransportEventHandler

onDisconnected

public void onDisconnected(boolean willReconnect)

Run when disconnected.

指定者:

onDisconnected 在接口中 TransportEventHandler

onConnected

public void onConnected()

Run when connected.

指定者:

onConnected 在接口中 TransportEventHandler

unsubscribeStreams

public void unsubscribeStreams()

resubscribeStreams

public void resubscribeStreams()

onMessageInClientThread

public void onMessageInClientThread(org.json.JSONObject msg)

Client message thread.

参数:

msg - JSONObject msg.

onTransactionResult

public void onTransactionResult(TransactionResult tr)

Transaction returned.

参数:

tr - Result data.

accountFromSeed

public Account accountFromSeed(String masterSeed)

Request account information.

参数:

masterSeed - Master seed for account.

返回:

Account information.

subscribe

public void subscribe(org.json.JSONObject subscription)

unsubscribe

public void unsubscribe(org.json.JSONObject subscription)

newRequest

public Request newRequest(Command cmd)

Create a new request.

参数:

cmd - Command name.

返回:

Request data.

sendRequest

public void sendRequest(Request request)

Send a request message.

参数:

request - Request data.

makeManagedRequest

public <T> Request makeManagedRequest(Command cmd,
                                      Request.Manager<T> manager,
                                      Request.Builder<T> builder)

Managed Requests API

类型参数:

T - Builder parameter type.

参数:

cmd - Command.

manager - Manager.

builder - Builder data.

返回:

Request data.

accountTxPager

public AccountTxPager accountTxPager(AccountID accountID)

Request account transaction page.

参数:

accountID - Account address.

返回:

AccountTxPager data.

requestLedgerEntry

public void requestLedgerEntry(Hash256 index,
                               Number ledger_index,
                               Request.Manager<LedgerEntry> cb)

Request for a ledger_entry.

参数:

index - Hash.

ledger_index - Ledger index.

cb - Callback.

requestBookOffers

public void requestBookOffers(Number ledger_index,
                              Issue get,
                              Issue pay,
                              Request.Manager<ArrayList<Offer>> cb)

Request for book_offers.

参数:

ledger_index - Ledger's index.

get - Get.

pay - Pay.

cb - Callback.

submit

public Request submit(String tx_blob,
                      boolean fail_hard)

Submit a transaction

参数:

tx_blob - Tx_blob signed.

fail_hard - Fail_hard.

返回:

Request data.

accountInfo

public org.json.JSONObject accountInfo(AccountID account)

Request for account information.

参数:

account - Account address.

返回:

Request data.

select

public org.json.JSONObject select(String secret,
                                  AccountID account,
                                  AccountID owner,
                                  String name,
                                  String raw,
                                  Publisher.Callback<org.json.JSONObject> cb)

Select data from chain.

参数:

secret - Account seed.

account - Account address.

owner - Table owner address.

name - Table name.

raw - Raw data.

cb - Callback function.

返回:

Request data.

getBySqlUser

public org.json.JSONObject getBySqlUser(String secret,
                                        String accountID,
                                        String sql)

getBySqlUser

public void getBySqlUser(String secret,
                         String accountID,
                         String sql,
                         Publisher.Callback<org.json.JSONObject> cb)

getBySqlAdmin

public org.json.JSONObject getBySqlAdmin(String sql)

getBySqlAdmin

public void getBySqlAdmin(String sql,
                          Publisher.Callback<org.json.JSONObject> cb)

getNameInDB

public org.json.JSONObject getNameInDB(String owner,
                                       String tableName)

getNameInDB

public void getNameInDB(String owner,
                        String tableName,
                        Publisher.Callback<org.json.JSONObject> cb)

getLedgerTxs

public org.json.JSONObject getLedgerTxs(Integer ledgerSeq,
                                        boolean bIncludeSuccess,
                                        boolean bIncludefailure)

getLedgerTxs

public void getLedgerTxs(Integer ledgerSeq,
                         boolean bIncludeSuccess,
                         boolean bIncludefailure,
                         Publisher.Callback<org.json.JSONObject> cb)

getLedger

public org.json.JSONObject getLedger(org.json.JSONObject option)

getLedger

public void getLedger(org.json.JSONObject option,
                      Publisher.Callback<org.json.JSONObject> cb)

Request for ledger data.

参数:

option - Ledger options.

cb - Callback.

getTransactions

public org.json.JSONObject getTransactions(String address,
                                           int limit)

getTransactions

public void getTransactions(String address,
                            int limit,
                            Publisher.Callback<org.json.JSONObject> cb)

Request for transaction information.

参数:

address - Account address.

limit - Transaction count limit.

cb - Callback.

getTransactions

public void getTransactions(String address,
                            int limit,
                            org.json.JSONObject marker,
                            Publisher.Callback<org.json.JSONObject> cb)

Request for transaction information.

参数:

address - Account address.

limit - Transaction count limit.

marker - Marker from previous call response.

cb - Callback.

getCrossChainTxs

public void getCrossChainTxs(String hash,
                             int limit,
                             boolean include,
                             Publisher.Callback<org.json.JSONObject> cb)

Request for transaction information.

参数:

hash - Tx hash ,if "" it will find first tx on this chain.

limit - Transaction count limit.

include - If include the transaction that hash point out.

cb - Callback.

getLedgerVersion

public org.json.JSONObject getLedgerVersion()

getLedgerVersion

public void getLedgerVersion(Publisher.Callback<org.json.JSONObject> cb)

getTransactionCount

public org.json.JSONObject getTransactionCount()

Get transaction count on chain.

返回:

Transaction account data.

getServerInfo

public org.json.JSONObject getServerInfo()

Get server_info

返回:

Server_info data.

getUnlList

public org.json.JSONObject getUnlList()

Get unl_list

返回:

unl_list data

getUserToken

public org.json.JSONObject getUserToken(String owner,
                                        String user,
                                        String name)

Get user_token for table,if token got not null, it is a confidential table.

参数:

owner - Table's owner/creator.

user - Operating account.

name - Table name.

返回:

Request object contains response data.

getUserToken

public void getUserToken(String owner,
                         String user,
                         String name,
                         Publisher.Callback<org.json.JSONObject> cb)

tablePrepare

public org.json.JSONObject tablePrepare(org.json.JSONObject txjson)

Prepare for a transaction for : filling in NameInDB field, filling in CheckHash field for StrictMode

参数:

txjson - tx_json with fields and value a transaction needed.

返回:

Prepared tx_json.

contractCall

public org.json.JSONObject contractCall(org.json.JSONObject obj)

contractCall synchronously

参数:

obj - call parameters

返回:

call return

GetAccountLines

public org.json.JSONObject GetAccountLines(String address)

GetAccountLines synchronously

参数:

address - Address to get trust lines.

返回:

account trustlines

getPeers

public org.json.JSONObject getPeers()

Get peers

返回:

peers data.

GetAccountLines

public void GetAccountLines(AccountID addy,
                            Publisher.Callback<org.json.JSONObject> cb)

Request for account_lines.

参数:

addy - account id.

cb - Callback.

getTableAuth

public org.json.JSONObject getTableAuth(String owner,
                                        String tableName,
                                        List<String> accounts)

getTableAuth

public void getTableAuth(String owner,
                         String tableName,
                         List<String> accounts,
                         Publisher.Callback<org.json.JSONObject> cb)

getAccountTables

public org.json.JSONObject getAccountTables(String address,
                                            boolean bGetDetail)

getAccountTables

public void getAccountTables(String address,
                             boolean bGetDetail,
                             Publisher.Callback<org.json.JSONObject> cb)

contractCall

public void contractCall(org.json.JSONObject obj,
                         Publisher.Callback<org.json.JSONObject> cb)

contractCall asynchronously

参数:

obj - call parameters

cb - Callback.

getTransaction

public org.json.JSONObject getTransaction(String hash)

getTransaction synchronously

参数:

hash - Transaction hash.

返回:

Transaction details.

getTransaction

public void getTransaction(String hash,
                           Publisher.Callback<org.json.JSONObject> cb)

Request for a transaction's information.

参数:

hash - Transaction hash.

cb - Callback.

getTransaction

public org.json.JSONObject getTransaction(org.json.JSONObject txInfo)

getTransaction synchronously

参数:

txInfo - tx information.

返回:

Transaction details.

ping

public Request ping()

Request ping.

返回:

ping Result.

subscribeAccount

public Request subscribeAccount(AccountID... accounts)

Subscribe for account.

参数:

accounts - Account addresses.

返回:

Request data.

unsubscribeAccount

public Request unsubscribeAccount(AccountID... accounts)

subscribeBookOffers

public Request subscribeBookOffers(Issue get,
                                   Issue pay)

Request for book-offers.

参数:

get - Get.

pay - Pay.

返回:

Request data.

requestBookOffers

public Request requestBookOffers(Issue get,
                                 Issue pay)

Request for book offers.

参数:

get - Get.

pay - Pay.

返回:

Request data.

getSchemaList

public org.json.JSONObject getSchemaList(org.json.JSONObject params)

Get schema_list

返回:

schema_list data.

getSchemaInfo

public org.json.JSONObject getSchemaInfo(String schemaID)

Request for schema_info.

参数:

schemaID - schemaID.

返回:

Request data.