Class SandboxContext
Namespace: DotBoxD.Kernels.Sandbox
Assembly: DotBoxD.Kernels.dll
public sealed class SandboxContextInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”SandboxContext(SandboxRunId, SandboxPolicy, ResourceMeter, BindingRegistry, IAuditSink, CancellationToken, IReadOnlySet<string>?, string?, string?)
Section titled “ SandboxContext(SandboxRunId, SandboxPolicy, ResourceMeter, BindingRegistry, IAuditSink, CancellationToken, IReadOnlySet<string>?, string?, string?)”public SandboxContext(SandboxRunId runId, SandboxPolicy policy, ResourceMeter budget, BindingRegistry bindings, IAuditSink audit, CancellationToken cancellationToken, IReadOnlySet<string>? allowedBindingIds = null, string? moduleHash = null, string? policyHash = null)Parameters
Section titled “Parameters”runId SandboxRunId
policy SandboxPolicy
budget ResourceMeter
bindings BindingRegistry
audit IAuditSink
cancellationToken CancellationToken
allowedBindingIds IReadOnlySet<string>?
moduleHash string?
policyHash string?
Properties
Section titled “Properties”AsyncEnabled
Section titled “ AsyncEnabled”public bool AsyncEnabled { get; }Property Value
Section titled “Property Value”public IAuditSink Audit { get; }Property Value
Section titled “Property Value”Bindings
Section titled “ Bindings”public BindingRegistry Bindings { get; }Property Value
Section titled “Property Value”Budget
Section titled “ Budget”public ResourceMeter Budget { get; }Property Value
Section titled “Property Value”CancellationToken
Section titled “ CancellationToken”public CancellationToken CancellationToken { get; }Property Value
Section titled “Property Value”ModuleHash
Section titled “ ModuleHash”public string ModuleHash { get; }Property Value
Section titled “Property Value”Policy
Section titled “ Policy”public SandboxPolicy Policy { get; }Property Value
Section titled “Property Value”PolicyHash
Section titled “ PolicyHash”public string PolicyHash { get; }Property Value
Section titled “Property Value”public SandboxRunId RunId { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”AuditCheckpoint()
Section titled “ AuditCheckpoint()”public long AuditCheckpoint()Returns
Section titled “Returns”AuditTimestamp()
Section titled “ AuditTimestamp()”public DateTimeOffset AuditTimestamp()Returns
Section titled “Returns”BeginBindingReturnCreditScope()
Section titled “ BeginBindingReturnCreditScope()”public IDisposable BeginBindingReturnCreditScope()Returns
Section titled “Returns”BindingAuditFields(string, DateTimeOffset, long?, long?)
Section titled “ BindingAuditFields(string, DateTimeOffset, long?, long?)”public IReadOnlyDictionary<string, string> BindingAuditFields(string resourceKind, DateTimeOffset startedAt, long? bytesRead = null, long? bytesWritten = null)Parameters
Section titled “Parameters”resourceKind string
startedAt DateTimeOffset
bytesRead long?
bytesWritten long?
Returns
Section titled “Returns”IReadOnlyDictionary<string, string>
ChargeAllocation(long)
Section titled “ ChargeAllocation(long)”public void ChargeAllocation(long bytes)Parameters
Section titled “Parameters”bytes long
ChargeBindingCall(BindingDescriptor)
Section titled “ ChargeBindingCall(BindingDescriptor)”public void ChargeBindingCall(BindingDescriptor descriptor)Parameters
Section titled “Parameters”descriptor BindingDescriptor
ChargeBindingReturn(BindingDescriptor, SandboxValue)
Section titled “ ChargeBindingReturn(BindingDescriptor, SandboxValue)”public SandboxValue ChargeBindingReturn(BindingDescriptor descriptor, SandboxValue value)Parameters
Section titled “Parameters”descriptor BindingDescriptor
value SandboxValue
Returns
Section titled “Returns”ChargeCollection(SandboxValue)
Section titled “ ChargeCollection(SandboxValue)”public void ChargeCollection(SandboxValue value)Parameters
Section titled “Parameters”value SandboxValue
ChargeFuel(long)
Section titled “ ChargeFuel(long)”public void ChargeFuel(long amount)Parameters
Section titled “Parameters”amount long
ChargeLogEvent(string)
Section titled “ ChargeLogEvent(string)”public void ChargeLogEvent(string message)Parameters
Section titled “Parameters”message string
ChargeLoopIteration(long)
Section titled “ ChargeLoopIteration(long)”public void ChargeLoopIteration(long fuelAmount)Parameters
Section titled “Parameters”fuelAmount long
ChargeLoopIterations(long, long)
Section titled “ ChargeLoopIterations(long, long)”public void ChargeLoopIterations(long iterations, long fuelPerIteration)Parameters
Section titled “Parameters”iterations long
fuelPerIteration long
ChargeString(string)
Section titled “ ChargeString(string)”public void ChargeString(string value)Parameters
Section titled “Parameters”value string
ChargeStringAllocation(int)
Section titled “ ChargeStringAllocation(int)”public void ChargeStringAllocation(int charLength)Parameters
Section titled “Parameters”charLength int
ChargeValue(SandboxValue)
Section titled “ ChargeValue(SandboxValue)”public void ChargeValue(SandboxValue value)Parameters
Section titled “Parameters”value SandboxValue
Checkpoint()
Section titled “ Checkpoint()”public void Checkpoint()CreateChargedStringConcat(string, string)
Section titled “ CreateChargedStringConcat(string, string)”public string CreateChargedStringConcat(string left, string right)Parameters
Section titled “Parameters”left string
right string
Returns
Section titled “Returns”CreateChargedSubstring(string, int, int)
Section titled “ CreateChargedSubstring(string, int, int)”public string CreateChargedSubstring(string value, int startIndex, int length)Parameters
Section titled “Parameters”value string
startIndex int
length int
Returns
Section titled “Returns”CreateWallTimeToken()
Section titled “ CreateWallTimeToken()”public CancellationTokenSource CreateWallTimeToken()Returns
Section titled “Returns”EnsureRequiredBindingFailureAudit(BindingDescriptor, long, SandboxErrorCode)
Section titled “ EnsureRequiredBindingFailureAudit(BindingDescriptor, long, SandboxErrorCode)”public void EnsureRequiredBindingFailureAudit(BindingDescriptor descriptor, long checkpoint, SandboxErrorCode errorCode)Parameters
Section titled “Parameters”descriptor BindingDescriptor
checkpoint long
errorCode SandboxErrorCode
EnsureRequiredBindingSuccessAudit(BindingDescriptor, long)
Section titled “ EnsureRequiredBindingSuccessAudit(BindingDescriptor, long)”public void EnsureRequiredBindingSuccessAudit(BindingDescriptor descriptor, long checkpoint)Parameters
Section titled “Parameters”descriptor BindingDescriptor
checkpoint long
EnterCall()
Section titled “ EnterCall()”public void EnterCall()ExitCall()
Section titled “ ExitCall()”public void ExitCall()GetCapability(string)
Section titled “ GetCapability(string)”public CapabilityGrant GetCapability(string capabilityId)Parameters
Section titled “Parameters”capabilityId string
Returns
Section titled “Returns”NextRandomInt32(int, int)
Section titled “ NextRandomInt32(int, int)”public int NextRandomInt32(int minInclusive, int maxExclusive)Parameters
Section titled “Parameters”minInclusive int
maxExclusive int
Returns
Section titled “Returns”RequireCapability(string)
Section titled “ RequireCapability(string)”public void RequireCapability(string capabilityId)Parameters
Section titled “Parameters”capabilityId string
UtcNow()
Section titled “ UtcNow()”public DateTimeOffset UtcNow()