#region Copyright notice and license
// Copyright 2015 gRPC authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#endregion
using System;
using System.Threading;
using System.Threading.Tasks;
using Grpc.Core.Internal;
namespace Grpc.Core
{
///
/// Context for a server-side call.
///
public class ServerCallContext
{
private readonly CallSafeHandle callHandle;
private readonly string method;
private readonly string host;
private readonly DateTime deadline;
private readonly Metadata requestHeaders;
private readonly CancellationToken cancellationToken;
private readonly Metadata responseTrailers = new Metadata();
private Status status = Status.DefaultSuccess;
private Func writeHeadersFunc;
private IHasWriteOptions writeOptionsHolder;
private Lazy authContext;
internal ServerCallContext(CallSafeHandle callHandle, string method, string host, DateTime deadline, Metadata requestHeaders, CancellationToken cancellationToken,
Func writeHeadersFunc, IHasWriteOptions writeOptionsHolder)
{
this.callHandle = callHandle;
this.method = method;
this.host = host;
this.deadline = deadline;
this.requestHeaders = requestHeaders;
this.cancellationToken = cancellationToken;
this.writeHeadersFunc = writeHeadersFunc;
this.writeOptionsHolder = writeOptionsHolder;
this.authContext = new Lazy(GetAuthContextEager);
}
///
/// Asynchronously sends response headers for the current call to the client. This method may only be invoked once for each call and needs to be invoked
/// before any response messages are written. Writing the first response message implicitly sends empty response headers if WriteResponseHeadersAsync haven't
/// been called yet.
///
/// The response headers to send.
/// The task that finished once response headers have been written.
public Task WriteResponseHeadersAsync(Metadata responseHeaders)
{
return writeHeadersFunc(responseHeaders);
}
///
/// Creates a propagation token to be used to propagate call context to a child call.
///
public ContextPropagationToken CreatePropagationToken(ContextPropagationOptions options = null)
{
return new ContextPropagationToken(callHandle, deadline, cancellationToken, options);
}
/// Name of method called in this RPC.
public string Method
{
get
{
return this.method;
}
}
/// Name of host called in this RPC.
public string Host
{
get
{
return this.host;
}
}
/// Address of the remote endpoint in URI format.
public string Peer
{
get
{
// Getting the peer lazily is fine as the native call is guaranteed
// not to be disposed before user-supplied server side handler returns.
// Most users won't need to read this field anyway.
return this.callHandle.GetPeer();
}
}
/// Deadline for this RPC.
public DateTime Deadline
{
get
{
return this.deadline;
}
}
/// Initial metadata sent by client.
public Metadata RequestHeaders
{
get
{
return this.requestHeaders;
}
}
/// Cancellation token signals when call is cancelled.
public CancellationToken CancellationToken
{
get
{
return this.cancellationToken;
}
}
/// Trailers to send back to client after RPC finishes.
public Metadata ResponseTrailers
{
get
{
return this.responseTrailers;
}
}
/// Status to send back to client after RPC finishes.
public Status Status
{
get
{
return this.status;
}
set
{
status = value;
}
}
///
/// Allows setting write options for the following write.
/// For streaming response calls, this property is also exposed as on IServerStreamWriter for convenience.
/// Both properties are backed by the same underlying value.
///
public WriteOptions WriteOptions
{
get
{
return writeOptionsHolder.WriteOptions;
}
set
{
writeOptionsHolder.WriteOptions = value;
}
}
///
/// Gets the AuthContext associated with this call.
/// Note: Access to AuthContext is an experimental API that can change without any prior notice.
///
public AuthContext AuthContext
{
get
{
return authContext.Value;
}
}
private AuthContext GetAuthContextEager()
{
using (var authContextNative = callHandle.GetAuthContext())
{
return authContextNative.ToAuthContext();
}
}
}
///
/// Allows sharing write options between ServerCallContext and other objects.
///
public interface IHasWriteOptions
{
///
/// Gets or sets the write options.
///
WriteOptions WriteOptions { get; set; }
}
}