GigaSpaces XAP.NET Documentation
IReadOnlySpaceProxy Interface
Class LibraryGigaSpaces.CoreIReadOnlySpaceProxy
Encapsulates a read-only space proxy.
Declaration Syntax
C#Visual BasicVisual C++J#
public interface IReadOnlySpaceProxy : IDisposable
Public Interface IReadOnlySpaceProxy _
	Implements IDisposable
public interface class IReadOnlySpaceProxy : IDisposable
public interface IReadOnlySpaceProxy extends IDisposable
Members
All MembersMethodsProperties



IconMemberDescription
BeginRead<(Of <(T>)>)(T, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(T, ITransaction, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(T, Int64, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(T, ITransaction, Int64, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(T, ITransaction, Int64, ReadModifiers, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(IQuery<(Of <(T>)>), AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(IQuery<(Of <(T>)>), Int64, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64, AsyncCallback<(Of <(T>)>), Object)
BeginRead<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64, ReadModifiers, AsyncCallback<(Of <(T>)>), Object)
Clustered
Returns true if the proxy is connected to a clustered space, otherwise false.

Count()()()
Count any object from the space, visible under the default transaction.

Count(Object)
Count any matching object from the space, visible under the default transaction.

Count(ITransaction)
Count any object from the space, visible under the specified transaction.

Count(Object, ITransaction)
Count any matching object from the space, visible under the specified transaction.

Count(Object, ITransaction, ReadModifiers)
Count any matching object from the space, visible under the specified transaction and modifiers.

CreateDataEventSession()()()
Create a data event session using the default configuration and transaction.

CreateDataEventSession(EventSessionConfig)
Create a data event session using the specified configuration and default transaction.

CreateDataEventSession(ITransaction) Obsolete.
Create a data event session using the default configuration and specified transaction.

CreateDataEventSession(EventSessionConfig, ITransaction) Obsolete.
Create a data event session using the specified configuration and transaction.

DefaultDataEventSession
Gets or sets the default IDataEventSession associated with the proxy.

DefaultEventSessionConfig
Gets or sets the default EventSessionConfig associated with the proxy.

DefaultLeaseTime
Gets or sets the default lease time associated with the proxy.

DefaultMaxItems
Gets or sets the default maximum items associated with the proxy.

DefaultTimeout
Gets or sets the default timeout associated with the proxy.

Dispose()()()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Embedded
Returns true if the proxy is connected to an embedded space, otherwise false.

EndRead<(Of <(T>)>)(IAsyncResult<(Of <(T>)>))
Waits for the pending asynchronous read to complete.

Fifo
Gets or sets Fifo mode for proxy.

FinderUrl
Returns the SpaceUrl instance which was used to find the space.

GetServerAdmin()()()
Returns a server administration component for the current proxy.

GetSpaceIterator<(Of <(T>)>)(T, IteratorScope) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(T>)>), IteratorScope) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(T, IteratorScope, Int32, Int64) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(T>)>), IteratorScope, Int32, Int64) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(IQuery<(Of <(T>)>), IteratorScope) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(IQuery<(Of <(T>)>)>)>), IteratorScope) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(IQuery<(Of <(T>)>), IteratorScope, Int32, Int64) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(IQuery<(Of <(T>)>)>)>), IteratorScope, Int32, Int64) Obsolete.
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(T, SpaceIteratorConfig)
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(T>)>), SpaceIteratorConfig)
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(IQuery<(Of <(T>)>), SpaceIteratorConfig)
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(IQuery<(Of <(T>)>)>)>), SpaceIteratorConfig)
Create an iterator over the space using the specified template(s) and settings.

GetSpaceIterator<(Of <(T>)>)(ICollection<(Of <(T>)>), ICollection<(Of <(IQuery<(Of <(T>)>)>)>), SpaceIteratorConfig)
Create an iterator over the space using the specified template(s) and settings.

Name
Gets the name of this space.

Ping()()()
Checks whether the space is alive and accessible.

Ping(Boolean)
Checks whether the space is alive and accessible.

Read<(Of <(T>)>)(T)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(T, ITransaction)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(T, Int64)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(T, ITransaction, Int64)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(T, ITransaction, Int64, ReadModifiers)
Read (according to the modifiers) any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(IQuery<(Of <(T>)>))
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(IQuery<(Of <(T>)>), Int64)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64)
Read any matching object from the space, blocking until one exists. Return null if the timeout expires.

Read<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64, ReadModifiers)
Read (according to the modifiers) any matching object from the space, blocking until one exists. Return null if the timeout expires.

ReadById(Type, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById(Type, Object, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById(Type, Object, Object, ITransaction)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById(Type, Object, Object, ITransaction, Int64)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById(Type, Object, Object, ITransaction, Int64, ReadModifiers)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById<(Of <(T>)>)(IdQuery<(Of <(T>)>))
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) until a matching entry is available.

ReadById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) until a matching entry is available.

ReadById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction, Int64)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) until a matching entry is available.

ReadById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction, Int64, ReadModifiers)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) until a matching entry is available.

ReadById<(Of <(T>)>)(Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById<(Of <(T>)>)(Object, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById<(Of <(T>)>)(Object, Object, ITransaction)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById<(Of <(T>)>)(Object, Object, ITransaction, Int64)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadById<(Of <(T>)>)(Object, Object, ITransaction, Int64, ReadModifiers)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) until a matching entry is avaliable.

ReadByIds(Type, array<Object>[]()[])
Read objects from the space matching their IDs and the specified class.

Note, if the space is partitioned and the Class defines a specific property for its routing value (which means that the ID property is not used for routing), the operation will broadcast to all partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], Object)
Read objects from the space matching their IDs, the specified class and routing key.

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], Object, ITransaction)
Read objects from the space matching their IDs, the specified class and routing key.

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], Object, ITransaction, ReadModifiers)
Read objects from the space matching their IDs, the specified class type and routing key, with the provided .

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], array<Object>[]()[])
Read objects from the space matching their IDs, the specified class and the routing keys.

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], array<Object>[]()[], ITransaction)
Read objects from the space matching their IDs, the specified class and the routing keys.

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds(Type, array<Object>[]()[], array<Object>[]()[], ITransaction, ReadModifiers)
Read objects from the space matching their IDs, the specified class and the routing keys, with the provided .

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[])
Read objects from the space matching their IDs and the specified class.

Note, if the space is partitioned and the Class defines a specific property for its routing value (which means that the ID property is not used for routing), the operation will broadcast to all partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], Object)
Read objects from the space matching their IDs, the specified class and routing key.

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], Object, ITransaction)
Read objects from the space matching their IDs, the specified class and routing key.

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], Object, ITransaction, ReadModifiers)
Read objects from the space matching their IDs, the specified class type and routing key, with the provided .

Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], array<Object>[]()[])
Read objects from the space matching their IDs, the specified class and the routing keys.

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], array<Object>[]()[], ITransaction)
Read objects from the space matching their IDs, the specified class and the routing keys.

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(array<Object>[]()[], array<Object>[]()[], ITransaction, ReadModifiers)
Read objects from the space matching their IDs, the specified class and the routing keys, with the provided .

Note, the IDs array and routing keys array are correlated and should be of the same size. The routing key of ID i in the IDs array is the element at position i in the routing keys array. If routingKeys is null and the cluster is partitioned, the operation will broadcast to all of the partitions.

FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.


ReadByIds<(Of <(T>)>)(IdsQuery<(Of <(T>)>))
Read objects from the space matching the specified ids query.

ReadByIds<(Of <(T>)>)(IdsQuery<(Of <(T>)>), ITransaction)
Read objects from the space matching the specified ids query.

ReadByIds<(Of <(T>)>)(IdsQuery<(Of <(T>)>), ITransaction, ReadModifiers)
Read objects from the space matching the specified ids query, with the provided ReadModifiers.

ReadIfExists<(Of <(T>)>)(T)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(T, ITransaction)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(T, Int64)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(T, ITransaction, Int64)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(T, ITransaction, Int64, ReadModifiers)
Read (according to the modifiers) any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(IQuery<(Of <(T>)>))
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(IQuery<(Of <(T>)>), Int64)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64)
Read any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExists<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int64, ReadModifiers)
Read (according to the modifiers) any matching object from the space, returning null if there currently is none. Equivalent to read, except that blocking is done only if necessary to wait for transactional state to settle.

ReadIfExistsById(Type, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById(Type, Object, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById(Type, Object, Object, ITransaction)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById(Type, Object, Object, ITransaction, Int64)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById(Type, Object, Object, ITransaction, Int64, ReadModifiers)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(IdQuery<(Of <(T>)>))
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction, Int64)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(IdQuery<(Of <(T>)>), ITransaction, Int64, ReadModifiers)
Read an entry matching the specified id query from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(Object, Object)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(Object, Object, ITransaction)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(Object, Object, ITransaction, Int64)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadIfExistsById<(Of <(T>)>)(Object, Object, ITransaction, Int64, ReadModifiers)
Reads an entry of the specified type with the specified id from the space. Blocks up to the specified timeout (if any) only if a matching entry exists and it is necessary to wait for transactional state to settle.

ReadModifiers
Gets or sets the default ReadModifiers associated with the proxy.

ReadMultiple<(Of <(T>)>)(T)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(T, ITransaction)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(T, Int32)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(T, ITransaction, Int32)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(T, ITransaction, Int32, ReadModifiers)
Read (according to the modifiers) an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(IQuery<(Of <(T>)>))
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(IQuery<(Of <(T>)>), Int32)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int32)
Read an array of matching objects from the space. Matching is done as in read with no timeout.

ReadMultiple<(Of <(T>)>)(IQuery<(Of <(T>)>), ITransaction, Int32, ReadModifiers)
Read (according to the modifiers) an array of matching objects from the space. Matching is done as in read with no timeout.

ReferentUid
Gets the unique uid of this space instance.

Secured
Returns true if this space secured, otherwise false.

SetSecurityContext(SecurityContext) Obsolete.
Applies a security context for following operations on the proxy.

Snapshot<(Of <(T>)>)(T)
Prepare the template for future operations on the proxy. Prepared templates are more efficient since the data is already serialized in the space format.

Snapshot<(Of <(T>)>)(IQuery<(Of <(T>)>))
Prepare the template for future operations on the proxy. Prepared templates are more efficient since the data is already serialized in the space format.

TypeManager
Gets the type manager of this space proxy instance. ISpaceTypeManager

Url
Returns the SpaceUrl instance which was used to initialize the space.

Assembly: GigaSpaces.Core (Module: GigaSpaces.Core) Version: 8.0.8.6380 (8.0.8.6380)