TransferMode

Native
1.3
enum class TransferMode
(source)

Object Transfer Basics.

Objects can be passed between threads in one of two possible modes.

  • SAFE - object subgraph is checked to be not reachable by other globals or locals, and passed if so, otherwise an exception is thrown
  • UNSAFE - object is blindly passed to another worker, if there are references left in the passing worker - it may lead to crash or program malfunction

Safe mode checks if object is no longer used in passing worker, using memory-management specific algorithm (ARC implementation relies on trial deletion on object graph rooted in passed object), and throws an IllegalStateException if object graph rooted in transferred object is reachable by some other means,

Unsafe mode is intended for most performance critical operations, where object graph ownership is expected to be correct (such as application debugged earlier in SAFE mode), just transfers ownership without further checks.

Note, that for some cases cycle collection need to be done to ensure that dead cycles do not affect reachability of passed object graph.

See Also

kotlin.native.internal.GC.collect

Enum Values

Native
1.3

SAFE

Reachibility check is performed.

Native
1.3

UNSAFE

Skip reachibility check, can lead to mysterious crashes in an application. USE UNSAFE MODE ONLY IF ABSOLUTELY SURE WHAT YOU'RE DOING!!!

Properties

Native
1.3

value

val value: Int