C# Class Hangfire.Mongo.MongoStorage

Hangfire Job Storage implementation for Mongo database
Inheritance: JobStorage
Mostrar archivo Open project: Trov/Hangfire.Mongo Class Usage Examples

Public Methods

Method Description
CreateAndOpenConnection ( ) : HangfireDbContext

Opens connection to database

GetComponents ( ) : IEnumerable

Returns collection of server components

GetConnection ( ) : IStorageConnection

Returns storage connection

GetMonitoringApi ( ) : IMonitoringApi

Returns Monitoring API object

GetStateHandlers ( ) : IEnumerable

Returns collection of state handers

MongoStorage ( MongoClientSettings mongoClientSettings, string databaseName ) : System

Constructs Job Storage by Mongo client settings and name

MongoStorage ( MongoClientSettings mongoClientSettings, string databaseName, MongoStorageOptions options ) : System

Constructs Job Storage by Mongo client settings, name and options

MongoStorage ( string connectionString, string databaseName ) : System

Constructs Job Storage by database connection string and name

MongoStorage ( string connectionString, string databaseName, MongoStorageOptions options ) : System

Constructs Job Storage by database connection string, name and options

ToString ( ) : string

Returns text representation of the object

WriteOptionsToLog ( ILog logger ) : void

Writes storage options to log

Method Details

CreateAndOpenConnection() public method

Opens connection to database
public CreateAndOpenConnection ( ) : HangfireDbContext
return Hangfire.Mongo.Database.HangfireDbContext

GetComponents() public method

Returns collection of server components
public GetComponents ( ) : IEnumerable
return IEnumerable

GetConnection() public method

Returns storage connection
public GetConnection ( ) : IStorageConnection
return IStorageConnection

GetMonitoringApi() public method

Returns Monitoring API object
public GetMonitoringApi ( ) : IMonitoringApi
return IMonitoringApi

GetStateHandlers() public method

Returns collection of state handers
public GetStateHandlers ( ) : IEnumerable
return IEnumerable

MongoStorage() public method

Constructs Job Storage by Mongo client settings and name
public MongoStorage ( MongoClientSettings mongoClientSettings, string databaseName ) : System
mongoClientSettings MongoDB.Driver.MongoClientSettings Client settings for MongoDB
databaseName string Database name
return System

MongoStorage() public method

Constructs Job Storage by Mongo client settings, name and options
public MongoStorage ( MongoClientSettings mongoClientSettings, string databaseName, MongoStorageOptions options ) : System
mongoClientSettings MongoDB.Driver.MongoClientSettings Client settings for MongoDB
databaseName string Database name
options MongoStorageOptions Storage options
return System

MongoStorage() public method

Constructs Job Storage by database connection string and name
public MongoStorage ( string connectionString, string databaseName ) : System
connectionString string MongoDB connection string
databaseName string Database name
return System

MongoStorage() public method

Constructs Job Storage by database connection string, name and options
public MongoStorage ( string connectionString, string databaseName, MongoStorageOptions options ) : System
connectionString string MongoDB connection string
databaseName string Database name
options MongoStorageOptions Storage options
return System

ToString() public method

Returns text representation of the object
public ToString ( ) : string
return string

WriteOptionsToLog() public method

Writes storage options to log
public WriteOptionsToLog ( ILog logger ) : void
logger ILog Logger
return void