Coldwave Documentation

Appearance

MessageResult ​

Possible Result Value returned in Flake Message Headers.

swift
enum MessageResult

Enumeration Cases ​

failed ​

swift
case failed

A general error Message, telling that the desired operation couldn’t be per- formed. Either it is not necessary to give more information or that information is not available

ignored ​

swift
case ignored

Used to tell the original source object that the destination has received the Message but doesn’t care. This is usally used by the implementation to tell that there is no client object that handles this Message.

noChanges ​

swift
case noChanges

If a setProperties Message doesn’t change anything on the object because all the values are the same before and after the call, this gets returned.

notConnceted ​

swift
case notConnceted

The logical Connection to the server has not been established.

notFound ​

swift
case notFound

Used, for example, in replies to getProperties requests with IDs that don’t match any of the properties known to the Router.

notImplemented ​

swift
case notImplemented

The desired functionality is not available. This can occur if a ”custom” Message type is sent and the destination doesn’t support it.

ok ​

swift
case ok

The operation was executed as expected.

partialSuccess ​

swift
case partialSuccess

When a setProperties or getProperties Message only could set or retrieve part of the originally intended properties, this gets returend. the payload should then be processed to get details

pending ​

swift
case pending

This should be treated as success in asynchronous operations

readOnly ​

swift
case readOnly

It was tried to write an object or property that the caller has read-only access to

timeout ​

swift
case timeout

The destination didn’t reply timely. this could be because there is heavy processing involved on the destination side or because of a race condition when the Connection has been closed while waiting for a reply

unregisteredObject ​

swift
case unregisteredObject

The destination address doesn’t refer to any object known to the system.

Initializers ​

init(rawValue:) ​

swift
init?(rawValue: Int8)

Default Implementations ​

Equatable-Implementations ​

Error-Implementations ​

RawRepresentable-Implementations ​