ReusableObjectPoolTakeObject(Type) Method

Gets an object from the pool, or creates a new one if no pool items are available.

Namespace: GSF
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.244-beta+c33f622c070b2c1078a06bcb41bdeb4c19d19a0b

Syntax

C++

JavaScript

Copy

public static Object TakeObject(
	Type type
)

Public Shared Function TakeObject ( 
	type As Type
) As Object

public:
static Object^ TakeObject(
	Type^ type
)

static member TakeObject : 
        type : Type -> Object

GSF.ReusableObjectPool.TakeObject = function(type);

View Source

Parameters

type Type: Type of object to get from pool.

Return Value

Object
An available object from the pool, or a new one if no pool items are available.

Exceptions

Exception	Condition
InvalidOperationException	type does not support parameterless public constructor.

Remarks

If type implements ISupportLifecycle, the pool will attach to the item's Disposed event such that the object can be automatically restored to the pool upon Dispose. It will be up to class implementors to make sure Initialize makes the class ready for use as this method will always be called for an object being taken from the pool.

Reference

ReusableObjectPool Class

TakeObject Overload

GSF Namespace