FileSystemOptions

Specifies the options required to leverage the local file system as the SimpleMessageBus backing queue.

Definition

Assembly: CloudNimble.SimpleMessageBus.Core.dll

Namespace: CloudNimble.SimpleMessageBus.Core

Inheritance: System.Object

Syntax

CloudNimble.SimpleMessageBus.Core.FileSystemOptions

Summary

Specifies the options required to leverage the local file system as the SimpleMessageBus backing queue.

Constructors

.ctor

The default constructor, which sets the default values equal to the values specified in FileSystemConstants.

Syntax

public FileSystemOptions()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

CompletedFolderPath

The folder segment where successfully-processed queue items will be moved to upon completion.

Syntax

public string CompletedFolderPath { get; }

Property Value

Type: string

ErrorFolderPath

The folder segment where failed items will be stored while they are waiting to be analyzed and reprocessed.

Syntax

public string ErrorFolderPath { get; }

Property Value

Type: string

IsNetworkPath

Gets a boolean specifying whether or not the FileSystemOptions.RootFolder is a network path (either a UNC or mapped drive).

Syntax

public bool IsNetworkPath { get; }

Property Value

Type: bool

QueueFolderPath

The folder segment where items will be stored while they are waiting to be processed.

Syntax

public string QueueFolderPath { get; }

Property Value

Type: string

RootFolder

A string representing the folder that will hold the three required queue folders.

Syntax

public string RootFolder { get; set; }

Property Value

Type: string

VirusScanDelayInSeconds

An integer representing the number of seconds to wait before firing FileSystemWatcher events to process the Queue.

Syntax

public int VirusScanDelayInSeconds { get; set; }

Property Value

Type: int

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?