CommonOptions

public class CommonOptions

Common options shared by container components.

  • Specify IO nodes associated with IO contexts for IO routing (optional).

    Each IO node definition is hashed by the IO context name the node should be associated with. An IO node definition includes IO sources and/or IO actors, and node-specific characteristics to be used for IO routing.

    If neither IO sources nor IO actors are specified for an IO node, its node definition is ignored.

    Declaration

    Swift

    public var ioContextNodes: [String : IoNodeDefinition]?
  • Property-value pairs to be configured on the identity object of the agent container (optional). Usually, an expressive name of the identity is configured here.

    Note

    objectType and coreType properties of an identity object are ignored, i.e. cannot be overridden.

    Declaration

    Swift

    public var agentIdentity: [String : Any]?
  • Agent information generated and injected into the configuration when the agent project is build (optional).

    Declaration

    Swift

    public var agentInfo: AgentInfo?
  • Additional application-specific properties (optional). Useful to inject service instances to be shared among controllers.

    Declaration

    Swift

    public var extra: [String : Any]
  • Determines the log level (default is .error) for logging CoatySwift internal errors, warnings, and informational messages.

    Declaration

    Swift

    public var logLevel: CoatySwiftLogLevel
  • Create a new CommonOptions instance.

    Declaration

    Swift

    public init(ioContextNodes: [String: IoNodeDefinition]? = nil,
    
                agentIdentity: [String: Any]? = nil,
    
                agentInfo: AgentInfo? = nil,
    
                extra: [String: Any]? = nil,
    
                logLevel: CoatySwiftLogLevel? = nil)