Class LocalAsyncSession
- All Implemented Interfaces:
AsyncSession
,Session
- Author:
- bratseth, jonmv
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Destroys this session and frees up any resources it has held.get
(com.yahoo.document.DocumentId id) Gets a document.get
(com.yahoo.document.DocumentId id, DocumentOperationParameters parameters) Gets a document.double
Returns the current send window size of the session.getNext()
Returns the next response of this session.getNext
(int timeoutMilliseconds) Returns the next response of this session.put
(com.yahoo.document.Document document) Puts a document.put
(com.yahoo.document.DocumentPut documentPut, DocumentOperationParameters parameters) Puts a document, with optional conditions on the operation.remove
(com.yahoo.document.DocumentId id) Removes a document if it is present.remove
(com.yahoo.document.DocumentRemove remove, DocumentOperationParameters parameters) Removes a document if it is present.void
setResultType
(Result.ResultType resultType) Sets the result type returned on subsequence operations against this.update
(com.yahoo.document.DocumentUpdate update) Updates a document.update
(com.yahoo.document.DocumentUpdate update, DocumentOperationParameters parameters) Updates a document.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.yahoo.documentapi.AsyncSession
put, remove
-
Constructor Details
-
LocalAsyncSession
-
-
Method Details
-
getCurrentWindowSize
public double getCurrentWindowSize()Description copied from interface:AsyncSession
Returns the current send window size of the session.- Specified by:
getCurrentWindowSize
in interfaceAsyncSession
- Returns:
- Returns the window size.
-
put
Description copied from interface:AsyncSession
Puts a document. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentResponse
objects to appear within the timeout time of this session. The response returned later will either be a success, or contain the document submitted here. If it was not a success, this method has no further effects.- Specified by:
put
in interfaceAsyncSession
- Parameters:
document
- the Document to put- Returns:
- the synchronous result of this operation
-
put
public Result put(com.yahoo.document.DocumentPut documentPut, DocumentOperationParameters parameters) Description copied from interface:AsyncSession
Puts a document, with optional conditions on the operation. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentResponse
objects to appear within the timeout time of this session. The response returned later will either be a success, or contain the document submitted here. If it was not a success, this method has no further effects.- Specified by:
put
in interfaceAsyncSession
- Parameters:
documentPut
- the DocumentPut to performparameters
- parameters for the operation- Returns:
- the synchronous result of this operation
-
get
Description copied from interface:AsyncSession
Gets a document. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentResponse
objects to appear within the timeout time of this session. The response returned later will contain the requested document if it is a success. If it was not a success, this method has no further effects.- Specified by:
get
in interfaceAsyncSession
- Parameters:
id
- the id of the document to get- Returns:
- the synchronous result of this operation
-
get
Description copied from interface:AsyncSession
Gets a document. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentResponse
objects to appear within the timeout time of this session. The response returned later will contain the requested document if it is a success. If it was not a success, this method has no further effects.- Specified by:
get
in interfaceAsyncSession
- Parameters:
id
- the id of the document to getparameters
- parameters for the operation- Returns:
- the synchronous result of this operation
-
remove
Description copied from interface:AsyncSession
Removes a document if it is present. This method returns immediately.
If this result is a success, this call will cause one or more
RemoveResponse
objects to appear within the timeout time of this session. The response returned later will either be a success, or contain the document id submitted here. If it was not a success, this method has no further effects.- Specified by:
remove
in interfaceAsyncSession
- Parameters:
id
- the id of the document to remove- Returns:
- the synchronous result of this operation
-
remove
public Result remove(com.yahoo.document.DocumentRemove remove, DocumentOperationParameters parameters) Description copied from interface:AsyncSession
Removes a document if it is present. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentIdResponse
objects to appear within the timeout time of this session. The response returned later will either be a success, or contain the document id submitted here. If it was not a success, this method has no further effects.- Specified by:
remove
in interfaceAsyncSession
- Parameters:
remove
- the document remove operationparameters
- parameters for the operation- Returns:
- the synchronous result of this operation
-
update
Description copied from interface:AsyncSession
Updates a document. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentUpdateResponse
within the timeout time of this session. The returned response returned later will either be a success or contain the update submitted here. If it was not a success, this method has no further effects.- Specified by:
update
in interfaceAsyncSession
- Parameters:
update
- the updates to perform- Returns:
- the synchronous result of this operation
-
update
public Result update(com.yahoo.document.DocumentUpdate update, DocumentOperationParameters parameters) Description copied from interface:AsyncSession
Updates a document. This method returns immediately.
If this result is a success, this call will cause one or more
DocumentUpdateResponse
within the timeout time of this session. The returned response returned later will either be a success or contain the update submitted here. If it was not a success, this method has no further effects.- Specified by:
update
in interfaceAsyncSession
- Parameters:
update
- the updates to performparameters
- parameters for the operation- Returns:
- the synchronous result of this operation
-
getNext
Description copied from interface:Session
Returns the next response of this session. This method returns immediately. -
getNext
Description copied from interface:Session
Returns the next response of this session. This will block until a response is ready or until the given timeout is reached- Specified by:
getNext
in interfaceSession
- Parameters:
timeoutMilliseconds
- the max time to wait for a response.- Returns:
- the next response, or null if no response becomes ready before the timeout expires
- Throws:
InterruptedException
- if this thread is interrupted while waiting
-
destroy
public void destroy()Description copied from interface:Session
Destroys this session and frees up any resources it has held. Making further calls on a destroyed session causes a runtime exception. -
setResultType
Sets the result type returned on subsequence operations against this. Only SUCCESS will cause Responses to appear.
-