/// <summary>
/// Initializes new instance.
/// </summary>
/// <param name="error">The metadata of the error.</param>
/// <param name="description">The description of the error which was occurred in local.</param>
/// <param name="debugInformation">The detailed debug information of the error which was occurred in local.</param>
/// <exception cref="ArgumentNullException">
/// <paramref name="error"/> is <c>null</c>.
/// </exception>
public RpcErrorMessage(RpcError error, string description, string debugInformation)
{
Contract.EndContractBlock();
_error = error ?? throw new ArgumentNullException(nameof(error));
var data = new MessagePackObjectDictionary(2);
if (description != null)
{
data.Add(RpcException.messageKeyUtf8, description);
}
if (debugInformation != null)
{
data.Add(RpcException.debugInformationKeyUtf8, debugInformation);
}
_detail = new MessagePackObject(data);
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcServerUnavailableException"/> class with the unpacked data.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="unpackedException">
/// Exception data from remote MessagePack-RPC server.
/// </param>
/// <exception cref="SerializationException">
/// Cannot deserialize instance from <paramref name="unpackedException"/>.
/// </exception>
internal RpcServerUnavailableException(RpcError rpcError, MessagePackObject unpackedException) : base(rpcError, unpackedException)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcServerUnavailableException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="message">
/// Error message to desribe condition. Note that this message should not include security related information.
/// </param>
/// <param name="debugInformation">
/// Debug information of error.
/// This value can be null for security reason, and its contents are for developers, not end users.
/// </param>
/// <param name="inner">
/// Exception which caused this error.
/// </param>
/// <remarks>
/// <para>
/// For example, if some exception is occurred in server application,
/// the value of <see cref="Exception.ToString()"/> should specify for <paramref name="debugInformation"/>.
/// And then, user-friendly, safe message should be specified to <paramref name="message"/> like 'Internal Error."
/// </para>
/// <para>
/// MessagePack-RPC for CLI runtime does not propagate <see cref="RpcException.DebugInformation"/> for remote endpoint.
/// So you should specify some error handler to instrument it (e.g. logging handler).
/// </para>
/// </remarks>
public RpcServerUnavailableException(RpcError rpcError, string message, string debugInformation, Exception inner)
: base(rpcError ?? RpcError.ServerError, message, debugInformation, inner)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcServerUnavailableException"/> class with a specified error message.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="message">
/// Error message to desribe condition. Note that this message should not include security related information.
/// </param>
/// <param name="debugInformation">
/// Debug information of error.
/// This value can be null for security reason, and its contents are for developers, not end users.
/// </param>
/// <remarks>
/// <para>
/// For example, if some exception is occurred in server application,
/// the value of <see cref="Exception.ToString()"/> should specify for <paramref name="debugInformation"/>.
/// And then, user-friendly, safe message should be specified to <paramref name="message"/> like 'Internal Error."
/// </para>
/// <para>
/// MessagePack-RPC for CLI runtime does not propagate <see cref="RpcException.DebugInformation"/> for remote endpoint.
/// So you should specify some error handler to instrument it (e.g. logging handler).
/// </para>
/// </remarks>
public RpcServerUnavailableException(RpcError rpcError, string message, string debugInformation)
: this(rpcError, message, debugInformation, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcServerUnavailableException"/> class with the default error message.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
public RpcServerUnavailableException(RpcError rpcError) : this(rpcError, null, null, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcException"/> class with a specified error message.
/// </summary>
/// <param name="rpcError">
/// The metadata of the error. If <c>null</c> is specified, the <see cref="Core.RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="message">
/// The error message to desribe condition. Note that this message should not include security related information.
/// </param>
/// <param name="debugInformation">
/// The debug information of the error.
/// This value can be <c>null</c> for security reason, and its contents are for developers, not end users.
/// </param>
/// <remarks>
/// <para>
/// For example, if some exception is occurred in server application,
/// the value of <see cref="Exception.ToString()"/> should specify for <paramref name="debugInformation"/>.
/// And then, user-friendly, safe message should be specified to <paramref name="message"/> like 'Internal Error."
/// </para>
/// <para>
/// MessagePack-RPC for CLI runtime does not propagate <see cref="DebugInformation"/> for remote endpoint.
/// So you should specify some error handler to instrument it (e.g. logging handler).
/// </para>
/// </remarks>
public RpcException(RpcError rpcError, string message, string debugInformation) : this(rpcError, message, debugInformation, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcFaultException"/> class with the unpacked data.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="unpackedException">
/// Exception data from remote MessagePack-RPC server.
/// </param>
/// <exception cref="SerializationException">
/// Cannot deserialize instance from <paramref name="unpackedException"/>.
/// </exception>
protected internal RpcFaultException(RpcError rpcError, MessagePackObject unpackedException)
: base(rpcError, unpackedException)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="RpcFaultException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
/// </summary>
/// <param name="rpcError">
/// Metadata of error. If you specify null, <see cref="RpcError.RemoteRuntimeError"/> is used.
/// </param>
/// <param name="message">
/// Error message to desribe condition. Note that this message should not include security related information.
/// </param>
/// <param name="debugInformation">
/// Debug information of error.
/// This value can be null for security reason, and its contents are for developers, not end users.
/// </param>
/// <param name="inner">
/// Exception which caused this error.
/// </param>
/// <remarks>
/// <para>
/// For example, if some exception is occurred in server application,
/// the value of <see cref="Exception.ToString()"/> should specify for <paramref name="debugInformation"/>.
/// And then, user-friendly, safe message should be specified to <paramref name="message"/> like 'Internal Error."
/// </para>
/// <para>
/// MessagePack-RPC for CLI runtime does not propagate <see cref="RpcException.DebugInformation"/> for remote endpoint.
/// So you should specify some error handler to instrument it (e.g. logging handler).
/// </para>
/// </remarks>
public RpcFaultException(RpcError rpcError, string message, string debugInformation, Exception inner) : base(rpcError, message, debugInformation, inner)
{
}
