Permalink
Fetching contributors…
Cannot retrieve contributors at this time
160 lines (160 sloc) 6.25 KB
<Type Name="Protocol" FullName="Microsoft.Azure.Documents.Client.Protocol">
<TypeSignature Language="C#" Value="public enum Protocol" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed Protocol extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Client.Protocol" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>
Specifies the protocol to be used by DocumentClient for communicating to the Azure DocumentDB service.
</summary>
<remarks>To be added.</remarks>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<altmember cref="T:Microsoft.Azure.Documents.Client.ConnectionMode" />
<altmember cref="T:Microsoft.Azure.Documents.Client.ConnectionPolicy" />
<altmember cref="T:Microsoft.Azure.Documents.Client.DocumentClient" />
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
<example>
<code language="c#"><![CDATA[
DocumentClient client = new DocumentClient(endpointUri, masterKey, new ConnectionPolicy
{
ConnectionMode = ConnectionMode.Direct,
ConnectionProtocol = Protocol.Tcp
});
]]></code>
</example>
</Docs>
<Members>
<Member MemberName="Https">
<MemberSignature Language="C#" Value="Https" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.Client.Protocol Https = int32(0)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.Client.Protocol.Https" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.Client.Protocol</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the HTTPS protocol.
</summary>
<remarks>Default connectivity.</remarks>
</Docs>
</Member>
<Member MemberName="Tcp">
<MemberSignature Language="C#" Value="Tcp" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Microsoft.Azure.Documents.Client.Protocol Tcp = int32(1)" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.Documents.Client.Protocol.Tcp" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Documents.Client.Protocol</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies a custom binary protocol on TCP.
</summary>
<remarks>Better for performance.</remarks>
</Docs>
</Member>
</Members>
</Type>