Show / Hide Table of Contents

Class BufferOptions

Options that define a buffer.

Inheritance
System.Object
BufferOptions
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.Diagnostics.Common
Assembly: Google.Cloud.Diagnostics.Common.dll
Syntax
public sealed class BufferOptions

Properties

BufferSizeBytes

The size of the buffer in bytes, only used for Sized

Declaration
public int BufferSizeBytes { get; }
Property Value
Type Description
System.Int32

BufferType

The type of buffer to be used.

Declaration
public BufferType BufferType { get; }
Property Value
Type Description
BufferType

BufferWaitTime

The time to wait before the buffer is flushed, only used for Timed

Declaration
public TimeSpan BufferWaitTime { get; }
Property Value
Type Description
System.TimeSpan

Methods

NoBuffer()

Create BufferOptions for None

Declaration
public static BufferOptions NoBuffer()
Returns
Type Description
BufferOptions

SizedBuffer(Int32)

Create BufferOptions for Sized

Declaration
public static BufferOptions SizedBuffer(int bufferSizeBytes = 65536)
Parameters
Type Name Description
System.Int32 bufferSizeBytes

Optional, The buffer size in bytes.

Returns
Type Description
BufferOptions

TimedBuffer(Nullable<TimeSpan>)

Create BufferOptions for Timed

Declaration
public static BufferOptions TimedBuffer(TimeSpan? bufferWaitTime = default(TimeSpan? ))
Parameters
Type Name Description
System.Nullable<System.TimeSpan> bufferWaitTime

Optional, The minimum amount of time between flushes.

Returns
Type Description
BufferOptions
Back to top