Class LocalAsyncSession
- java.lang.Object
-
- com.yahoo.documentapi.local.LocalAsyncSession
-
- All Implemented Interfaces:
AsyncSession
,Session
public class LocalAsyncSession extends java.lang.Object implements AsyncSession
- Author:
- bratseth
-
-
Constructor Summary
Constructors Constructor Description LocalAsyncSession(AsyncParameters params, LocalDocumentAccess access)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
destroy()
Destroys this session and frees up any resources it has held.Result
get(com.yahoo.document.DocumentId id)
Gets a document.Result
get(com.yahoo.document.DocumentId id, boolean headersOnly, DocumentProtocol.Priority pri)
Deprecated.Result
get(com.yahoo.document.DocumentId id, DocumentProtocol.Priority pri)
Gets a document.double
getCurrentWindowSize()
Returns the current send window size of the session.Response
getNext()
Returns the next response of this session.Response
getNext(int timeout)
Returns the next response of this session.Result
put(com.yahoo.document.Document document)
Puts a document.Result
put(com.yahoo.document.DocumentPut documentPut, DocumentProtocol.Priority pri)
Puts a document, with optional conditions on the operation.Result
remove(com.yahoo.document.DocumentId id)
Removes a document if it is present.Result
remove(com.yahoo.document.DocumentId id, DocumentProtocol.Priority pri)
Removes a document if it is present.Result
update(com.yahoo.document.DocumentUpdate update)
Updates a document.Result
update(com.yahoo.document.DocumentUpdate update, DocumentProtocol.Priority pri)
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, put
-
-
-
-
Constructor Detail
-
LocalAsyncSession
public LocalAsyncSession(AsyncParameters params, LocalDocumentAccess access)
-
-
Method Detail
-
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
public Result put(com.yahoo.document.Document document)
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, DocumentProtocol.Priority pri)
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 perform- Returns:
- the synchronous result of this operation
-
get
public Result get(com.yahoo.document.DocumentId id)
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
@Deprecated public Result get(com.yahoo.document.DocumentId id, boolean headersOnly, DocumentProtocol.Priority pri)
Deprecated.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 getpri
- The priority with which to perform this operation.- Returns:
- the synchronous result of this operation
-
get
public Result get(com.yahoo.document.DocumentId id, DocumentProtocol.Priority pri)
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 getpri
- The priority with which to perform this operation.- Returns:
- the synchronous result of this operation
-
remove
public Result remove(com.yahoo.document.DocumentId id)
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.DocumentId id, DocumentProtocol.Priority pri)
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 apprear 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 removepri
- The priority with which to perform this operation.- Returns:
- the synchronous result of this operation
-
update
public Result update(com.yahoo.document.DocumentUpdate 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, DocumentProtocol.Priority pri)
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 performpri
- The priority with which to perform this operation.- Returns:
- the synchronous result of this operation
-
getNext
public Response getNext()
Description copied from interface:Session
Returns the next response of this session. This method returns immediately.
-
getNext
public Response getNext(int timeout)
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
-
-