Icecast Server/Events

Events

Overview

Icecast 2.5.x features an event subsystem. This subsystem is used to deliver information on certain events that happen within the server to backends. In it's nature it is very similar to the auth subsystem. However in contrast to the auth subsystem it cannot modify the server state in any way. This makes it much more performant at the cost of slightly less usecases. Events in the event subsystem are inherently delivered asynchronously. Therefore they may arrive at some handler in any order. However information regarding their causality is preserved via their data.

List of events

event	Context	Description
icecast-start	Global	Emitted when Icecast has been started up initially.
icecast-stop	Global	Emitted as part of Icecast's shutdown.
icecast-active	Global	Emitted when Icecast is active (has sources connected).
icecast-idle	Global	Emitted when Icecast is in idle (no sources connected).
source-connect	Source	Emitted when a source enters running state.
source-disconnect	Source	Emitted when a source is shut down.
source-flags-changed	Source	Emitted when a source experiences changes of it's flags. This might be for internal and external reasons.
format-metadata-changed	Source	Emitted whenever the metadata on the format level changes.
dumpfile-opened	Source	Emitted when a dumpfile was just opened. At the time this is emitted any operations on the dumpfile as per the operating systems specification on open files are allowed. This usually includes renaming the file and moving it between directories on the same volume.
dumpfile-closed	Source	Emitted when a dumpfile is closed. **Note:** At this point Icecast knows hardly anything about the dumpfile anymore. So not all information is available to handlers of this event. Any operation should be done via dumpfile-opened whenever possible.
dumpfile-error	Source	Emitted when a dumpfile cannot be opened for any reason. See also dumpfile-opened.