Class OdinCipherHandle

Optional, pluggable encryption module for room communications. A cipher can be attached to an ODIN room handle on creation to enable customizable, end-to-end encryption (E2EE). When enabled, it intercepts data right before transmission and immediately after reception, allowing custom processing of datagrams, messages and custom peer user data. The structure provides a suite of callback functions for initialization, cleanup, event handling and encryption/decryption tasks, along with parameters to adjust for any additional capacity overhead.

Declaration

public class OdinCipherHandle : SafeHandleZeroOrMinusOneIsInvalid, IDisposable

Inheritance: System.Object -> System.Runtime.ConstrainedExecution.CriticalFinalizerObject -> System.Runtime.InteropServices.SafeHandle -> Microsoft.Win32.SafeHandles.SafeHandleZeroOrMinusOneIsInvalid

Implements:
System.IDisposable

Properties

IsAlive

Declaration

public bool IsAlive { get; }

Methods

ReleaseHandle()

When overridden in a derived class, executes the code required to free the handle.

Declaration

protected override bool ReleaseHandle()

Returns

System.Boolean: true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed Managed Debugging Assistant.

Implements

• System.IDisposable