ScalaCollider/de.sciss.synth/Server

Server

object Server extends ServerPlatform
Companion
class
class Object
trait Matchable
class Any

Type members

Classlikes

sealed trait Condition extends Update
object Config
Companion
class
final class Config extends ConfigLike
object ConfigBuilder
Companion
class
final class ConfigBuilder extends ConfigLike
trait ConfigLike

The base trait for Config and ConfigBuilder describes the settings used to boot scsynth in realtime or non-realtime mode, as well as its server address and port.

The base trait for Config and ConfigBuilder describes the settings used to boot scsynth in realtime or non-realtime mode, as well as its server address and port.

You obtain a ConfigBuilder by calling Server.Config(). This builder can then be mutated and will be implicitly converted to an immutable Config when required.

See ConfigBuilder for its default values.

See also
final case class Counts(c: StatusReply) extends Update
case object Offline extends Condition
case object Running extends Condition
sealed trait Update

Types

type Listener = Listener[Update]

Inherited types

type Address = InetSocketAddress
Inherited from
ServerPlatform

Value members

Concrete methods

def allocPort(transport: Transport): Int
def boot(name: String, config: Config, clientConfig: Config)(listener: Listener): ServerConnection
def connect(name: String, config: Config, clientConfig: Config)(listener: Listener): ServerConnection
def dummy(name: String, config: Config, clientConfig: Config): Server

Creates an unconnected server proxy. This may be useful for creating NRT command files. Any attempt to try to send messages to the server will fail.

Creates an unconnected server proxy. This may be useful for creating NRT command files. Any attempt to try to send messages to the server will fail.

def printError(name: String, t: Throwable): Unit
def renderNRT(dur: Double, config: Config): Processor[Int] & Prepared

Starts an NRT rendering process based on the NRT parameters of the configuration argument.

Starts an NRT rendering process based on the NRT parameters of the configuration argument.

'''Note:''' The returned process must be explicitly started by calling start()

Value Params
config

the server configuration in which nrtCommandPath must be set

dur

the duration of the bounce, used to emit process updates

Returns

the process whose return value is the process exit code of scsynth (0 indicating success)

def run(code: Server => Unit): Unit
def run(config: Config)(code: Server => Unit): Unit

Utility method to test code quickly with a running server. This boots a server and executes the passed in code when the server is up. A shutdown hook is registered to make sure the server is destroyed when the VM exits.

Utility method to test code quickly with a running server. This boots a server and executes the passed in code when the server is up. A shutdown hook is registered to make sure the server is destroyed when the VM exits.

def version: Try[(String, String)]
def version(config: Config): Try[(String, String)]

Inherited methods

def defaultProgram: String

The default file path to scsynth. If the runtime (system) property "SC_HOME" is provided, this specifies the directory of scsynth. Otherwise, an environment (shell) variable named "SC_HOME" is checked. If neither exists, this returns scsynth in the current working directory.

The default file path to scsynth. If the runtime (system) property "SC_HOME" is provided, this specifies the directory of scsynth. Otherwise, an environment (shell) variable named "SC_HOME" is checked. If neither exists, this returns scsynth in the current working directory.

Inherited from
ServerPlatform
def isLocal(addr: Address): Boolean
Inherited from
ServerPlatform
protected def prepareConnection(serverConfig: Config, clientConfig: Config): (Address, Client)
Inherited from
ServerPlatform

Implicits

Implicits

implicit def defaultGroup(s: Server): Group