IExceptionService
Name | Value |
---|---|
Assembly | Catel.Core |
Namespace | Catel.ExceptionHandling |
Available on | .NET Framework 4.5, .NET Framework 4.6, Portable Class Libraries, Xamarin - Android, Xamarin - iOS |
public interface IExceptionService
This interface describes a simple Exception service.
Properties
ExceptionHandlers
Gets the exception handlers.
Events
ExceptionBuffered
Occurs when an exception is buffered.
RetryingAction
Occurs when an action is retrying.
Methods
GetHandler(Type exceptionType)
Gets the exception handler for the specified exception type.
Parameters
Name | Description |
---|---|
exceptionType | Type of the exception. |
Returns
The exception handler.
Exceptions
Name | Description |
---|---|
ArgumentNullException | The isnull . |
ArgumentException | The exceptionType is not of type. |
GetHandler<TException>()
Gets the exception handler for the specified exception type.
Type Parameters
TException The type of the exception.
Returns
The exception handler.
HandleException(Exception exception)
Handles the specified exception if possible.
Parameters
Name | Description |
---|---|
exception | The exception to handle. |
Returns
true
if the exception is handled; otherwisefalse
.
Exceptions
Name | Description |
---|---|
ArgumentNullException | The exception isnull . |
IsExceptionRegistered(Type exceptionType)
Determines whether the specified exception type is registered.
Parameters
Name | Description |
---|---|
exceptionType | Type of the exception. |
Returns
true
if the specified exception type is registered; otherwise,false
.
Exceptions
Name | Description |
---|---|
ArgumentNullException | The isnull . |
ArgumentException | The exceptionType is not of type. |
IsExceptionRegistered<TException>()
Determines whether the specified exception type is registered.
Type Parameters
TException The type of the exception.
Returns
true
if the exception type is registered; otherwise,false
.
Process(Action action)
Processes the specified action.
Parameters
Name | Description |
---|---|
action | The action. |
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
Process<TResult>(Func<TResult> action)
Processes the specified action.
Type Parameters
TResult The result type.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessAsync(Func<Task> action)
Processes the specified action.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessAsync(Task action)
Processes the specified action.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessAsync<TResult>(Func<Task<TResult>> action)
Processes the specified action.
Type Parameters
TResult The result type.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessAsync<TResult>(Func<TResult> action, CancellationToken cancellationToken)
Processes the specified action. The action will be executed asynchronously.
Type Parameters
TResult The result type.
Parameters
Name | Description |
---|---|
action | The action. |
cancellationToken | The cancellation token. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessWithRetry<TResult>(Func<TResult> action)
Processes the specified action with possibility to retry on error.
Type Parameters
TResult The result type.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
ProcessWithRetryAsync<TResult>(Func<Task<TResult>> action)
Processes asynchronously the specified action with possibility to retry on error.
Type Parameters
TResult The result type.
Parameters
Name | Description |
---|---|
action | The action. |
Returns
Exceptions
Name | Description |
---|---|
ArgumentNullException | The action isnull . |
Register(IExceptionHandler handler)
Registers an handler for a specific exception.
Parameters
Name | Description |
---|---|
handler | The handler to use when the exception occurs. |
Returns
The handler to use.
Exceptions
Name | Description |
---|---|
ArgumentNullException | The handler isnull . |
Register<TException>(Action<TException> handler, Func<TException, bool> exceptionPredicate)
Registers a specific exception including the handler.
Type Parameters
TException The type of the exception.
Parameters
Name | Description |
---|---|
handler | The action to execute when the exception occurs. |
exceptionPredicate | The exception filter. |
Returns
The handler to use.
Exceptions
Name | Description |
---|---|
ArgumentNullException | The handler isnull . |
Exception | A delegate callback throws an exception. |
Unregister<TException>()
Unregisters a specific exception for handling.
Type Parameters
TException The type of the exception.
Returns
true
if the exception is unsubscripted; otherwisefalse
.
Have a question about Catel? Use StackOverflow with the Catel tag!