Coldwave Documentation

Appearance

Flake Core ​

Classes ​

FlakeClient ​

swift
class FlakeClient

Client to handle a connection via the flake protocol

FlakeObject ​

swift
class FlakeObject

Representaion of an Instance conforming to a Flake Service

FlakePropertyWrapper ​

swift
class FlakePropertyWrapper

Property wrapper for FlakeRepresentable objects

ReadOnlyFlakePropertyWrapper ​

swift
class ReadOnlyFlakePropertyWrapper

Property wrapper for FlakeRepresentable objects

Protocols ​

AuthenticationProvider ​

swift
protocol AuthenticationProvider

Protocol used define Object that can be provided to openConnection on FlakeClient This allows to provide authentication properties for connect Message

DataEncodable ​

swift
protocol DataEncodable

Protocol to define Types that are representable as Data used on all Flake compatible Data types.

FlakePropertyProtocol ​

swift
protocol FlakePropertyProtocol

Protocol to represent a generic FlakeProperty inlcuding one that represents a Failed Property

FlakePropertyType ​

swift
protocol FlakePropertyType

Protocol to define Flake Compatible Value Types

FlakeRepresentable ​

swift
protocol FlakeRepresentable

Protocol to define a domain specific Object that can be registerd with a Flake Client

ReadableFlakeProperty ​

swift
protocol ReadableFlakeProperty

Protocol used to enable FlakeRepresentable objects fill properties wrapped with PropertyWrappers like FlakePropertyWrapper or ReadOnlyFlakePropertyWrapper

SettableFlakeProperty ​

swift
protocol SettableFlakeProperty

Protocol used to enable FlakeRepresentable objects to trigger setProperties Messages for properties wrapped with PropertyWrappers like FlakePropertyWrapper or ReadOnlyFlakePropertyWrapper

Wire ​

swift
protocol Wire

Protcol describing a simple connection, able to send and reveive Data

Structures ​

CustomMessage ​

swift
struct CustomMessage

Representation of a Flake customMessage

EmptyAuthenticationProvider ​

swift
struct EmptyAuthenticationProvider

Default implementation for AuthenticationProvider used if no authentication is nessesary

FailedProperty ​

swift
struct FailedProperty

Representation of an Error localised on a change to one Property

FlakeClientConfiguration ​

swift
struct FlakeClientConfiguration

Configuration struct for a Flake Client

Property ​

swift
struct Property

Generic Flake Property

Type Aliases ​

Address ​

swift
typealias Address

Flake address Type

ConnectionStatusListener ​

swift
typealias ConnectionStatusListener

Closure Definition for callbacks to receive updates about the ConnectionStatus

FlakePropertyError ​

swift
typealias FlakePropertyError

Used in FailedProperty to indicate a specified reason

PropertyResultHandler ​

swift
typealias PropertyResultHandler

Closure Definition for callbacks which can fail and expect an Array of Properties on a success.

Enumerations ​

ConnectionError ​

swift
enum ConnectionError

Error Type to represent connection based Errors

ConnectionStatus ​

swift
enum ConnectionStatus

Used to describe the state of a connection to a Router

MessageResult ​

swift
enum MessageResult

Possible Result Value returned in Flake Message Headers.

PayloadDecodingError ​

swift
enum PayloadDecodingError

Describing Errors that occure during decoding of Message Payloads

PropertyType ​

swift
enum PropertyType

Enum Representing the Value Type of a Flake Property used for en/decoding

ProtocolError ​

swift
enum ProtocolError

Protocol Level Errors used for received messages that are maleformed

TimeoutError ​

swift
enum TimeoutError

Error Representing a timeout