Skip to main content
Socket.prototype.setMulticastTTL - node__dgram.d.ts - Node documentation
method Socket.prototype.setMulticastTTL

Usage in Deno

```typescript import { Socket } from "node:node__dgram.d.ts"; ```
Socket.prototype.setMulticastTTL(ttl: number): number
Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for "Time to Live", in this context it specifies the number of IP hops that a packet is allowed to travel through, specifically for multicast traffic. Each router or gateway that forwards a packet decrements the TTL. If the TTL is decremented to 0 by a router, it will not be forwarded. The `ttl` argument may be between 0 and 255\. The default on most systems is `1`. This method throws `EBADF` if called on an unbound socket.

Parameters

ttl: number

Return Type

number