RemoteActorConnection (kontraktor-bare 3.33 API)

java.lang.Object
- org.nustaq.kontraktor.barebone.RemoteActorConnection

```
public class RemoteActorConnection
extends Object
```
Created by ruedi on 05/06/15. A Json encoded Http Long Poll Client Note all callbacks are delivered in the same single thread. NEVER BLOCK THIS THREAD. Use an ExecutorService to perform blocking code or code with longer duration from within a callback. Objects of unknown (not on classpath) classes returned / required by the Remote Actor are translated into "Unknown" instances. Note that its favourable to create kind of a shared clientprotocol.jar to get properly deserlialized and typed results.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static org.apache.http.impl.nio.client.CloseableHttpAsyncClient`	`asyncHttpClient`
`protected ConcurrentHashMap<Long,Callback>`	`callbackMap` callback id => promise or callback
`protected org.nustaq.serialization.FSTConfiguration`	`conf`
`protected ConnectionListener`	`connectionListener`
`static boolean`	`DumpProtocol`
`protected String`	`id`
`protected AtomicLong`	`idCount` used to generate unique ids for callbacks/promises/actors
`protected boolean`	`isConnected`
`protected String`	`jwt`
`protected long`	`lastPing`
`protected int`	`lastSeenSeq`
`static int`	`LONG_POLL_MAX_TIME`
`static int`	`MAX_CONN_PER_ROUTE`
`static int`	`MAX_CONN_TOTAL`
`protected static ExecutorService`	`myExec`
`protected AtomicInteger`	`openFutureRequests` number of unreplied 'ask' calls.
`protected ArrayList<RemoteCallEntry>`	`requests` buffered requests to be sent, will be batched
`protected boolean`	`requestUnderway`
`protected String`	`sessionId`
`protected String`	`sessionUrl`
`protected long`	`timeout`
`protected static Timer`	`timer`

Constructor Summary

Constructors
Constructor and Description
`RemoteActorConnection(ConnectionListener connectionListener)` create a default configures (json serialization, no shared refs, no pretty print)
`RemoteActorConnection(ConnectionListener connectionListener, boolean sharedRefs)` note that shared refs support requires the server to be also configured for json shared refs.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addRequest(RemoteCallEntry remoteCallEntry, Promise res)`
`protected void`	`checkTimeout()`
`void`	`close()`
`Promise<RemoteActor>`	`connect(String url, boolean longPoll)`
`protected org.apache.http.client.methods.HttpPost`	`createRequest(String url, byte[] message)`
`protected void`	`delayed(Runnable runnable, long millis)` util to semd delayed jobs to processing/callback thread
`protected void`	`disconnect(String s)`
`org.apache.http.impl.nio.client.CloseableHttpAsyncClient`	`getClient()`
`ConnectionListener`	`getConnectionListener()`
`String`	`getId()`
`String`	`getJwt()`
`int`	`getOpenFutureRequests()`
`long`	`getTimeout()`
`RemoteActorConnection`	`id(String id)`
`protected void`	`initConf(boolean sharedRefs)`
`RemoteActorConnection`	`jwt(String jwt)`
`protected void`	`log(String s)`
`protected void`	`log(Throwable e)`
`protected void`	`processDecodedResultArray(Object[] o)`
`protected int`	`processResponse(byte[] b)`
`protected long`	`registerCallback(Callback res)`
`protected Promise<Integer>`	`sendCallArray(Object[] req)` encodes amd semds (incl seqNo).
`protected void`	`sendRequests()` sends pending requests async.
`void`	`sendShortPoll()` send an empty request polling for messages on server side.
`void`	`setTimeout(long timeout)`
`protected void`	`startLongPoll()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LONG_POLL_MAX_TIME
```
public static final int LONG_POLL_MAX_TIME
```
See Also:

Constant Field Values

MAX_CONN_PER_ROUTE
```
public static int MAX_CONN_PER_ROUTE
```

MAX_CONN_TOTAL
```
public static int MAX_CONN_TOTAL
```

DumpProtocol
```
public static boolean DumpProtocol
```

asyncHttpClient

protected static org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncHttpClient

isConnected
```
protected volatile boolean isConnected
```

conf

protected org.nustaq.serialization.FSTConfiguration conf

myExec

protected static ExecutorService myExec

sessionId
```
protected String sessionId
```

sessionUrl
```
protected String sessionUrl
```

lastSeenSeq
```
protected int lastSeenSeq
```

connectionListener

protected ConnectionListener connectionListener

timeout
```
protected volatile long timeout
```

lastPing
```
protected long lastPing
```

jwt
```
protected String jwt
```

id
```
protected String id
```

callbackMap

protected ConcurrentHashMap<Long,Callback> callbackMap

callback id => promise or callback

idCount
```
protected AtomicLong idCount
```
used to generate unique ids for callbacks/promises/actors

requestUnderway
```
protected boolean requestUnderway
```

requests
```
protected ArrayList<RemoteCallEntry> requests
```
buffered requests to be sent, will be batched

openFutureRequests
```
protected AtomicInteger openFutureRequests
```
number of unreplied 'ask' calls. Backpressure can be done by observing this. Its important your server app always returns a result or error (no silent timeout), else callbacks will stack up and this count will increase. Backpressure by limiting open futures then at some point will stall the client. TODO: add time based timeout for unreplied futures.

timer
```
protected static Timer timer
```

Constructor Detail
- RemoteActorConnection
```
public RemoteActorConnection(ConnectionListener connectionListener)
```
  create a default configures (json serialization, no shared refs, no pretty print)
  
  Parameters:
  
  connectionListener -
- RemoteActorConnection
```
public RemoteActorConnection(ConnectionListener connectionListener,
                             boolean sharedRefs)
```
  note that shared refs support requires the server to be also configured for json shared refs. as currenlty the js client does not support this, its likely server run with shared refs false.
  
  Parameters:
  
  sharedRefs -

Method Detail

getClient

public org.apache.http.impl.nio.client.CloseableHttpAsyncClient getClient()

getConnectionListener

public ConnectionListener getConnectionListener()

initConf

protected void initConf(boolean sharedRefs)

getTimeout
```
public long getTimeout()
```

setTimeout
```
public void setTimeout(long timeout)
```

connect

public Promise<RemoteActor> connect(String url,
                                    boolean longPoll)

startLongPoll
```
protected void startLongPoll()
```

checkTimeout
```
protected void checkTimeout()
```

delayed
```
protected void delayed(Runnable runnable,
                       long millis)
```
util to semd delayed jobs to processing/callback thread

Parameters:

runnable -

millis -

addRequest

protected void addRequest(RemoteCallEntry remoteCallEntry,
                          Promise res)

getOpenFutureRequests
```
public int getOpenFutureRequests()
```

sendShortPoll
```
public void sendShortPoll()
```
send an empty request polling for messages on server side. Unlike long poll, this request returns immediately and is not delayed by the server

sendRequests
```
protected void sendRequests()
```
sends pending requests async. needs be executed inside lock (see calls of this)

sendCallArray
```
protected Promise<Integer> sendCallArray(Object[] req)
```
encodes amd semds (incl seqNo). needs be executed inside lock (see calls of this)

getJwt
```
public String getJwt()
```

getId
```
public String getId()
```

jwt

public RemoteActorConnection jwt(String jwt)

id

public RemoteActorConnection id(String id)

processResponse

protected int processResponse(byte[] b)

close
```
public void close()
```

disconnect
```
protected void disconnect(String s)
```

processDecodedResultArray

protected void processDecodedResultArray(Object[] o)

registerCallback

protected long registerCallback(Callback res)

log
```
protected void log(Throwable e)
```

log
```
protected void log(String s)
```

createRequest

protected org.apache.http.client.methods.HttpPost createRequest(String url,
                                                                byte[] message)

Class RemoteActorConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LONG_POLL_MAX_TIME

MAX_CONN_PER_ROUTE

MAX_CONN_TOTAL

DumpProtocol

asyncHttpClient

isConnected

conf

myExec

sessionId

sessionUrl

lastSeenSeq

connectionListener

timeout

lastPing

jwt

id

callbackMap

idCount

requestUnderway

requests

openFutureRequests

timer

Constructor Detail

RemoteActorConnection

RemoteActorConnection

Method Detail

getClient

getConnectionListener

initConf

getTimeout

setTimeout

connect

startLongPoll

checkTimeout

delayed

addRequest

getOpenFutureRequests

sendShortPoll

sendRequests

sendCallArray

getJwt

getId

jwt

id

processResponse

close

disconnect

processDecodedResultArray

registerCallback

log

log

createRequest