Icecast Server/YP-protocol-v2 - Revision history

EPirat: Add note about HTTP header handling quirks

2020-06-20T01:33:54Z

Add note about HTTP header handling quirks

← Older revision		Revision as of 01:33, 20 June 2020
Line 96:		Line 96:
	\|\|TouchFreq: \|\|The frequency (in seconds) in which the listing client needs to touch the server in order to prevent a stale record		\|\|TouchFreq: \|\|The frequency (in seconds) in which the listing client needs to touch the server in order to prevent a stale record
	\|}		\|}

			'''Attention''': Even though HTTP headers are specified to be case-insensitive, Icecast versions prior to 2.4.0 and Icecast-kh do not handle them properly and will fail to parse the server response properly if the header names do not match the exact case as written above!

	==== Touch ====		==== Touch ====

EPirat: moved Icecast/YP-protocol-v2 to Icecast Server/YP-protocol-v2: This page is actually about Icecast Server, not the Icecast Project

2015-04-11T15:20:51Z

moved Icecast/YP-protocol-v2 to Icecast Server/YP-protocol-v2: This page is actually about Icecast Server, not the Icecast Project

← Older revision		Revision as of 15:20, 11 April 2015
(No difference)

EPirat: Added section links, corrected titles

2015-04-11T03:30:36Z

Added section links, corrected titles

← Older revision		Revision as of 03:30, 11 April 2015
Line 39:		Line 39:
	There are 3 defined request types:		There are 3 defined request types:

	* [[#~~add~~\|Add]]		* [[#Add\|Add]]
	* [[#~~touch~~\|Touch]]		* [[#Touch\|Touch]]
	* [[#~~remove~~\|Remove]]		* [[#Remove\|Remove]]

	==== Add ====		==== Add ====
Line 97:		Line 97:
	\|}		\|}

	==== ~~touch~~ ====		==== Touch ====

	This type of request will update a server entry with new information. This request will also cause the listing server to acknowledge this server as one that is still valid. Periodic cleanups of inactive servers will be performed on the listing server.		This type of request will update a server entry with new information. This request will also cause the listing server to acknowledge this server as one that is still valid. Periodic cleanups of inactive servers will be performed on the listing server.
Line 140:		Line 140:
	\|YPMessage: \|\|string\|\|Any error message		\|YPMessage: \|\|string\|\|Any error message
	\|}		\|}
	==== ~~remove~~ ====		==== Remove ====

	This type of request will remove a server entry.		This type of request will remove a server entry.

EPirat: /* Request types */

2015-04-11T03:29:36Z

Request types

← Older revision		Revision as of 03:29, 11 April 2015
Line 39:		Line 39:
	There are 3 defined request types:		There are 3 defined request types:

	* Add		* [[#add\|Add]]
	* Touch		* [[#touch\|Touch]]
	* Remove		* [[#remove\|Remove]]

	==== Add ====		==== Add ====

EPirat: Added relevant RFC link

2015-04-11T03:26:07Z

Added relevant RFC link

← Older revision		Revision as of 03:26, 11 April 2015
Line 33:		Line 33:
	Content-Type: application/x-www-form-urlencoded</code>		Content-Type: application/x-www-form-urlencoded</code>

	The directory request is contained in the message body as urlencoded data.		The directory request is contained in the message body as form-urlencoded data, see [https://tools.ietf.org/html/rfc1866#section-8.2.1 RFC 1866, Section 8.2.1].

	=== Request types ===		=== Request types ===

MrZeus: /* Request types */ fix mini-typos

2015-03-17T12:04:46Z

Request types: fix mini-typos

← Older revision		Revision as of 12:04, 17 March 2015
Line 52:		Line 52:
	!parameter !! value !! explanation		!parameter !! value !! explanation
	\|-		\|-
	\|action \|\| '''add''' \|\| ~~They~~ YP protocol request type		\|action \|\| '''add''' \|\| The YP protocol request type
	\|-		\|-
	\|sn \|\| string \|\| The name of the stream		\|sn \|\| string \|\| The name of the stream
Line 107:		Line 107:
	!parameter !! value !! explanation		!parameter !! value !! explanation
	\|-		\|-
	\|action \|\| '''~~remove~~''' \|\| ~~They~~ YP protocol request type		\|action \|\| '''touch''' \|\| The YP protocol request type
	\|-		\|-
	\|sid \|\| string \|\| session ID		\|sid \|\| string \|\| session ID
Line 151:		Line 151:
	!parameter !! value !! explanation		!parameter !! value !! explanation
	\|-		\|-
	\|action \|\| '''remove''' \|\| ~~They~~ YP protocol request type		\|action \|\| '''remove''' \|\| The YP protocol request type
	\|-		\|-
	\|sid \|\| string \|\| session ID		\|sid \|\| string \|\| session ID

Dm8tbr: added 'remove', some clean up, still needs variable types fixed

2015-03-15T10:15:44Z

added 'remove', some clean up, still needs variable types fixed

← Older revision		Revision as of 10:15, 15 March 2015
Line 44:		Line 44:

	==== Add ====		==== Add ====
	This type of request will add a new server entry to the directory.		This type of request will add a new server entry to the directory.

	The request MUST have the following parameters :		The request MUST have the following parameters :
Line 99:		Line 99:
	==== touch ====		==== touch ====

	This type of request will update a server entry with new information. This request will also cause the listing server to acknowledge this server as one that is still valid. Periodic cleanups of inactive servers will be performed on the listing server.		This type of request will update a server entry with new information. This request will also cause the listing server to acknowledge this server as one that is still valid. Periodic cleanups of inactive servers will be performed on the listing server.

	The URL call will have the following mandatory parameters :		The URL call will have the following mandatory parameters :
Line 107:		Line 107:
	!parameter !! value !! explanation		!parameter !! value !! explanation
	\|-		\|-
	\|action \|\| '''~~add~~''' \|\| They YP protocol request type		\|action \|\| '''remove''' \|\| They YP protocol request type
	\|-		\|-
	\|sid \|\| string \|\| session ID		\|sid \|\| string \|\| session ID
Line 139:		Line 139:
	\|-		\|-
	\|YPMessage: \|\|string\|\|Any error message		\|YPMessage: \|\|string\|\|Any error message
			\|}
			==== remove ====

			This type of request will remove a server entry.
			This request should be done when either the broadcast has stopped, or the icecast2 server is shutting down.

			The URL call will have the following mandatory parameters :

			{\| class="wikitable"
			\|-
			!parameter !! value !! explanation
			\|-
			\|action \|\| '''remove''' \|\| They YP protocol request type
			\|-
			\|sid \|\| string \|\| session ID
			\|}

			The URL call does NOT have optional parameters!

			The listing scripts will respond with the following HTTP headers
			{\| class="wikitable"
	\|-		\|-
	\|~~TouchFreq~~: \|\| \|\|~~''verify if this is honored, wasn't in old spec'' The frequency (in seconds) in which the listing client needs to touch the server in order to prevent a stale record~~		!header !! value !! explanation
			\|-
			\|YPResponse: \|\|0;1\|\|0-failure or 1-success
			\|-
			\|YPMessage: \|\|string\|\|Any error message
	\|}		\|}

Dm8tbr: some content, mainly based on very old spec

2015-03-08T20:09:00Z

some content, mainly based on very old spec

Show changes

Dm8tbr: We do explain this in the documentation already, this is a technical collaboration page for people already familiar with the YP protocol.

2015-02-08T16:46:40Z

We do explain this in the documentation already, this is a technical collaboration page for people already familiar with the YP protocol.

← Older revision		Revision as of 16:46, 8 February 2015
Line 1:		Line 1:
	This page is to document and help collaborate on drafting and later finalizing a complete revision of the Icecast YP protocol and YP server behaviour~~. It will also explain what 'YP' is~~.		This page is to document and help collaborate on drafting and later finalizing a complete revision of the Icecast YP protocol and YP server behaviour.

Martin.leese: Hopefully

2015-02-08T16:43:06Z

Hopefully

← Older revision		Revision as of 16:43, 8 February 2015
Line 1:		Line 1:
	This page is to document and help collaborate on drafting and later finalizing a complete revision of the Icecast YP protocol and YP server behaviour.		This page is to document and help collaborate on drafting and later finalizing a complete revision of the Icecast YP protocol and YP server behaviour. It will also explain what 'YP' is.