Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool Class Reference

Public Member Functions
	ReconnectLocationPool ()
	Create a default empty reconnect location pool More...
	ReconnectLocationPool (ICollection< ReconnectLocation > locations)
	Create a new reconnection location pool with the provided initial entries. More...
void	Shuffle ()
	Shuffle the elements in the pool producing a new randomized sequence of reconnection locations based on the original set. More...
ReconnectLocationPool	Add (ReconnectLocation location)
	Adds the given location to this pool if it is not already contained within. More...
ReconnectLocationPool	AddAll (IEnumerable< ReconnectLocation > locations)
	Adds the given enumeration of locations to this pool, filtering for duplicates. More...
ReconnectLocationPool	AddFirst (ReconnectLocation location)
	Adds the given location to this pool at the front if it is not already contained within. More...
bool	Remove (ReconnectLocation location)
	Removes the given location from the pool if present. If a value was removed this method return true otherwise it returns false. More...
ReconnectLocationPool	RemoveAll ()
	Removes all current entries from this pool leaving it in an empty state. More...
void	ReplaceAll (IEnumerable< ReconnectLocation > replacements)
	Removes all currently configured ReconnectLocation values from the pool and replaces them with the new set given. More...
IList< ReconnectLocation >	ToList ()
	Returns a list that contains a copy of each element contained in this reconnect location pool which can be empty if the pool is empty. More...
override string	ToString ()

Static Public Member Functions
static void	ShuffleMe (IList< ReconnectLocation > list)

Properties
int	Count [get]
	Gets the current number of entries that are stored in the pool. More...
bool	IsEmpty [get]
	Checks if the reconnection location pool is empty or not More...
ReconnectLocation?	Next [get]
	Returns the next reconnection location from the pool and moves its place in the pool to the end of the list meaning it will eventually be returned again unless removed from the pool. More...

Constructor & Destructor Documentation

ReconnectLocationPool() [1/2]

Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ReconnectLocationPool ( )

inline

Create a default empty reconnect location pool

ReconnectLocationPool() [2/2]

Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ReconnectLocationPool ( ICollection< ReconnectLocation >  locations )

inline

Create a new reconnection location pool with the provided initial entries.

Parameters

locations

The initial collection of entries to add to the pool

Member Function Documentation

Add()

ReconnectLocationPool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Add ( ReconnectLocation  location )

inline

Adds the given location to this pool if it is not already contained within.

Parameters

location

The new location to be added to the pool

Returns

This reconnect locations pool

AddAll()

ReconnectLocationPool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.AddAll ( IEnumerable< ReconnectLocation >  locations )

inline

Adds the given enumeration of locations to this pool, filtering for duplicates.

Parameters

locations

The enumeration of locations to be added to the pool

Returns

This reconnect locations pool

AddFirst()

ReconnectLocationPool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.AddFirst ( ReconnectLocation  location )

inline

Adds the given location to this pool at the front if it is not already contained within.

Parameters

location

The new location to be added to the pool

Returns

This reconnect locations pool

Remove()

bool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Remove ( ReconnectLocation  location )

inline

Removes the given location from the pool if present. If a value was removed this method return true otherwise it returns false.

Parameters

location

The location that should be removed from the pool

Returns

true if a value was removed from the pool, and false otherwise

RemoveAll()

ReconnectLocationPool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.RemoveAll ( )

inline

Removes all current entries from this pool leaving it in an empty state.

Parameters

location

The location to remove

Returns

This reconnection location pool instance

ReplaceAll()

void Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ReplaceAll ( IEnumerable< ReconnectLocation >  replacements )

inline

Removes all currently configured ReconnectLocation values from the pool and replaces them with the new set given.

Parameters

replacements

The new set of ReconnectLocation values to serve from this pool

Shuffle()

void Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Shuffle ( )

inline

Shuffle the elements in the pool producing a new randomized sequence of reconnection locations based on the original set.

ToList()

IList<ReconnectLocation> Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.ToList ( )

inline

Returns a list that contains a copy of each element contained in this reconnect location pool which can be empty if the pool is empty.

Returns

Property Documentation

Count

int Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Count

get

Gets the current number of entries that are stored in the pool.

IsEmpty

bool Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.IsEmpty

get

Checks if the reconnection location pool is empty or not

Next

ReconnectLocation? Apache.Qpid.Proton.Client.Utilities.ReconnectLocationPool.Next

get

Returns the next reconnection location from the pool and moves its place in the pool to the end of the list meaning it will eventually be returned again unless removed from the pool.

---

The documentation for this class was generated from the following file:

• src/Proton.Client/Client/Utilities/ReconnectLocationPool.cs