package multicast

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

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package multicast provides utilities for network multicast.

	    interface.go
	    multicast.go
	    udp.go
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type AddrResolver (struct)

		Fields (only one)
			Addr string
		As Inputs Of (at least one exported)
			func Listen(r *AddrResolver, opts ...ConnOption) (*Conn, error)
		As Types Of (only one)
			  var RecvAddrResolver *AddrResolver

	 type BytesDataProvider ([])

		Methods (only one)
			( BytesDataProvider) Bytes(ifi *net.Interface) []byte
		Implements (at least one exported)
			 BytesDataProvider : DataProvider

	 type Conn (struct)
		Conn is multicast connection.

		Methods (total 4)
			(*Conn) Close() error
				Close closes a multicast connection.

			(*Conn) LocalAddr() net.Addr
				LocalAddr returns local address to listen multicast packets.

			(*Conn) ReadPackets(timeout time.Duration, h PacketHandler) error
				ReadPackets reads multicast packets.

			(*Conn) WriteTo(dataProv DataProvider, to net.Addr) (int, error)
				WriteTo sends a multicast message to interfaces.

		Implements (at least 2)
			*Conn : github.com/prometheus/common/expfmt.Closer
			*Conn : io.Closer
		As Outputs Of (at least one exported)
			func Listen(r *AddrResolver, opts ...ConnOption) (*Conn, error)

	 type ConnOption (interface)
		ConnOption is option for Listen()

		As Outputs Of (at least 2)
			func ConnSystemAssginedInterface() ConnOption
			func ConnTTL(ttl int) ConnOption
		As Inputs Of (at least one exported)
			func Listen(r *AddrResolver, opts ...ConnOption) (*Conn, error)

	 type DataProvider (interface)
		DataProvider provides a body of multicast message to send.

		Methods (only one)
			( DataProvider) Bytes(*net.Interface) []byte
		Implemented By (at least one exported)
			 BytesDataProvider
		As Inputs Of (at least one exported)
			func (*Conn).WriteTo(dataProv DataProvider, to net.Addr) (int, error)

	 type InterfacesProviderFunc (func)

		As Types Of (only one)
			  var InterfacesProvider

	 type PacketHandler (func)

		As Inputs Of (at least one exported)
			func (*Conn).ReadPackets(timeout time.Duration, h PacketHandler) error


Package-Level Functions (total 6)

	 func ConnSystemAssginedInterface() ConnOption
	 func ConnTTL(ttl int) ConnOption
		ConnTTL returns as ConnOption that set default TTL to the connection.

	 func Listen(r *AddrResolver, opts ...ConnOption) (*Conn, error)
		Listen starts to receiving multicast messages.

	 func SendAddr() (*net.UDPAddr, error)
		SendAddr returns an address to send multicast UDP package.

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

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


Package-Level Variables (total 3)

	  var InterfacesProvider InterfacesProviderFunc
		InterfacesProvider specify a function to list all interfaces to multicast.
		If no provider are given, all possible interfaces will be used.

	  var RecvAddrResolver *AddrResolver
	  var SystemAssignedInterface bool
		SystemAssignedInterface indicates use the system assigned multicast interface or not.
		InterfacesProvider will be ignored when this is true.

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.