package ssdp

Import Path
	github.com/koron/go-ssdp (on go.dev)

Dependency Relation
	imports 14 packages, and imported by one package

Involved Source Files

	    advertise.go
	    announce.go
	  d doc.go
		Package ssdp provides SSDP advertiser or so.

	    location.go
	    monitor.go
	    option.go
	    search.go
	    ssdp.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type Advertiser (struct)
		Advertiser is a server to advertise a service.

		Methods (total 3)
			(*Advertiser) Alive() error
				Alive announces ssdp:alive message.

			(*Advertiser) Bye() error
				Bye announces ssdp:byebye message.

			(*Advertiser) Close() error
				Close stops advertisement.

		Implements (at least 2)
			*Advertiser : github.com/prometheus/common/expfmt.Closer
			*Advertiser : io.Closer
		As Outputs Of (at least one exported)
			func Advertise(st, usn string, location any, server string, maxAge int, opts ...Option) (*Advertiser, error)

	 type AliveHandler (func)
		AliveHandler is handler of Alive message.

	 type AliveMessage (struct)
		AliveMessage represents SSDP's ssdp:alive message.

		Fields (total 5)
			From net.Addr
				From is a sender of this message

			Location string
				Location is a property of "LOCATION"

			Server string
				Server is a property of "SERVER"

			Type string
				Type is a property of "NT"

			USN string
				USN is a property of "USN"

		Methods (total 2)
			(*AliveMessage) Header() http.Header
				Header returns all properties in alive message.

			(*AliveMessage) MaxAge() int
				MaxAge extracts "max-age" value from "CACHE-CONTROL" property.


	 type ByeHandler (func)
		ByeHandler is handler of Bye message.

	 type ByeMessage (struct)
		ByeMessage represents SSDP's ssdp:byebye message.

		Fields (total 3)
			From net.Addr
				From is a sender of this message

			Type string
				Type is a property of "NT"

			USN string
				USN is a property of "USN"

		Methods (only one)
			(*ByeMessage) Header() http.Header
				Header returns all properties in bye message.


	 type LocationProvider (interface)
		LocationProvider provides address for Location header which can be reached from
		"from" address network.

		Methods (only one)
			( LocationProvider) Location(from net.Addr, ifi *net.Interface) string
				Location provides an address be reachable from the network located
				by "from" address or "ifi" interface.
				One of "from" or "ifi" must not be nil.

		Implemented By (at least one exported)
			 LocationProviderFunc

	 type LocationProviderFunc (func)
		LocationProviderFunc type is an adapter to allow the use of ordinary
		functions are location providers.

		Methods (only one)
			( LocationProviderFunc) Location(from net.Addr, ifi *net.Interface) string
		Implements (at least one exported)
			 LocationProviderFunc : LocationProvider

	 type Monitor (struct)
		Monitor monitors SSDP's alive and byebye messages.

		Fields (total 4)
			Alive AliveHandler
			Bye ByeHandler
			Options []Option
			Search SearchHandler
		Methods (total 2)
			(*Monitor) Close() error
				Close closes monitoring.

			(*Monitor) Start() error
				Start starts to monitor SSDP messages.

		Implements (at least 2)
			*Monitor : github.com/prometheus/common/expfmt.Closer
			*Monitor : io.Closer

	 type Option (interface)
		Option is option set for SSDP API.

		As Outputs Of (at least 3)
			func AdvertiseHost() Option
			func OnlySystemInterface() Option
			func TTL(ttl int) Option
		As Inputs Of (at least 4)
			func Advertise(st, usn string, location any, server string, maxAge int, opts ...Option) (*Advertiser, error)
			func AnnounceAlive(nt, usn string, location any, server string, maxAge int, localAddr string, opts ...Option) error
			func AnnounceBye(nt, usn, localAddr string, opts ...Option) error
			func Search(searchType string, waitSec int, localAddr string, opts ...Option) ([]Service, error)

	 type SearchHandler (func)
		SearchHandler is handler of Search message.

	 type SearchMessage (struct)
		SearchMessage represents SSDP's ssdp:discover message.

		Fields (total 2)
			From net.Addr
			Type string
		Methods (only one)
			(*SearchMessage) Header() http.Header
				Header returns all properties in search message.


	 type Service (struct)
		Service is discovered service.

		Fields (total 4)
			Location string
				Location is a property of "LOCATION"

			Server string
				Server is a property of "SERVER"

			Type string
				Type is a property of "ST"

			USN string
				USN is a property of "USN"

		Methods (total 2)
			(*Service) Header() http.Header
				Header returns all properties in response of search.

			(*Service) MaxAge() int
				MaxAge extracts "max-age" value from "CACHE-CONTROL" property.

		As Outputs Of (at least one exported)
			func Search(searchType string, waitSec int, localAddr string, opts ...Option) ([]Service, error)


Package-Level Functions (total 9)

	 func Advertise(st, usn string, location any, server string, maxAge int, opts ...Option) (*Advertiser, error)
		Advertise starts advertisement of service.
		location should be a string or a ssdp.LocationProvider.

	 func AdvertiseHost() Option
		AdvertiseHost returns as Option that add HOST header to response for
		M-SEARCH requests.
		This option works with Advertise() function only.
		This is added to support SmartThings.
		See https://github.com/koron/go-ssdp/issues/30 for details.

	 func AnnounceAlive(nt, usn string, location any, server string, maxAge int, localAddr string, opts ...Option) error
		AnnounceAlive sends ssdp:alive message.
		location should be a string or a ssdp.LocationProvider.

	 func AnnounceBye(nt, usn, localAddr string, opts ...Option) error
		AnnounceBye sends ssdp:byebye message.

	 func OnlySystemInterface() Option
		OnlySystemInterface returns as Option that using only a system assigned
		multicast interface.

	 func Search(searchType string, waitSec int, localAddr string, opts ...Option) ([]Service, error)
		Search searches services by SSDP.

	 func SetMulticastRecvAddrIPv4(addr string) error
		SetMulticastRecvAddrIPv4 updates multicast address where to receive packets.
		This never fail now.

	 func SetMulticastSendAddrIPv4(addr string) error
		SetMulticastSendAddrIPv4 updates a UDP address to send multicast packets.
		This never fail now.

	 func TTL(ttl int) Option
		TTL returns as Option that set TTL for multicast packets.


Package-Level Variables (total 2)

	  var Interfaces []net.Interface
		Interfaces specify target interfaces to multicast.  If no interfaces are
		specified, all interfaces will be used.

	  var Logger *log.Logger
		Logger is default logger for SSDP module.


Package-Level Constants (total 2)

	const All = "ssdp:all"
		All is a search type to search all services and devices.

	const RootDevice = "upnp:rootdevice"
		RootDevice is a search type to search UPnP root devices.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.