Skip to main content

​
Overview

The NetworkType enum represents the combination of transport protocol (UDP or TCP) and IP version (IPv4 or IPv6) used for ICE candidates.

​
Type Definition

type NetworkType int

​
Types

​
NetworkTypeUDP4

const NetworkTypeUDP4 NetworkType = iota + 1
UDP over IPv4. This is the most common network type for ICE.

​
NetworkTypeUDP6

const NetworkTypeUDP6
UDP over IPv6.

​
NetworkTypeTCP4

const NetworkTypeTCP4
TCP over IPv4. Used for ICE-TCP.

​
NetworkTypeTCP6

const NetworkTypeTCP6
TCP over IPv6. Used for ICE-TCP.

​
Methods

​
String

func (t NetworkType) String() string
Returns the string representation of the network type. Returns:
  • "udp4" for NetworkTypeUDP4
  • "udp6" for NetworkTypeUDP6
  • "tcp4" for NetworkTypeTCP4
  • "tcp6" for NetworkTypeTCP6

​
NetworkShort

func (t NetworkType) NetworkShort() string
Returns the short protocol name without IP version. Returns:
  • "udp" for UDP types
  • "tcp" for TCP types

​
IsUDP

func (t NetworkType) IsUDP() bool
Returns true if the network type uses UDP (UDP4 or UDP6).

​
IsTCP

func (t NetworkType) IsTCP() bool
Returns true if the network type uses TCP (TCP4 or TCP6).

​
IsIPv4

func (t NetworkType) IsIPv4() bool
Returns true if the network type uses IPv4 (UDP4 or TCP4).

​
IsIPv6

func (t NetworkType) IsIPv6() bool
Returns true if the network type uses IPv6 (UDP6 or TCP6).

​
IsReliable

func (t NetworkType) IsReliable() bool
Returns true if the transport is reliable (TCP). Returns:
  • true for TCP types
  • false for UDP types

​
Usage Examples

// Only use UDP over IPv4 and IPv6
agent, _ := ice.NewAgentWithOptions(
    ice.WithNetworkTypes([]ice.NetworkType{
        ice.NetworkTypeUDP4,
        ice.NetworkTypeUDP6,
    }),
)

​
Default Behavior

When no network types are specified, all four types are enabled by default: 
// Default: All network types enabled
agent, _ := ice.NewAgentWithOptions()
// Equivalent to:
agent, _ := ice.NewAgentWithOptions(
    ice.WithNetworkTypes([]ice.NetworkType{
        ice.NetworkTypeUDP4,
        ice.NetworkTypeUDP6,
        ice.NetworkTypeTCP4,
        ice.NetworkTypeTCP6,
    }),
)

​
ICE-TCP Considerations

When using TCP network types, you may need to configure TCP-specific options: 
agent, _ := ice.NewAgentWithOptions(
    ice.WithNetworkTypes([]ice.NetworkType{
        ice.NetworkTypeTCP4,
        ice.NetworkTypeTCP6,
    }),
    // TCP candidates have lower priority by default
    ice.WithTCPPriorityOffset(27), // Default offset
    
    // Optionally disable active TCP candidates
    ice.WithDisableActiveTCP(),
    
    // Use TCP multiplexer for passive candidates
    ice.WithTCPMux(tcpMux),
)

​
Filtering Network Types

You can also filter at the IP level: 
// Accept only IPv4 addresses
agent, _ := ice.NewAgentWithOptions(
    ice.WithIPFilter(func(ip net.IP) bool {
        return ip.To4() != nil
    }),
)

​
Address Rewrite Rules

Network types can be used to scope address rewrite rules: 
import "github.com/pion/ice/v4"

agent, _ := ice.NewAgentWithOptions(
    ice.WithAddressRewriteRules(
        ice.AddressRewriteRule{
            External: []string{"203.0.113.10"},
            Networks: []ice.NetworkType{
                ice.NetworkTypeUDP4, // Only for UDP4
            },
        },
    ),
)

​
Matrix of Characteristics

Network TypeProtocolIP VersionReliableString
NetworkTypeUDP4UDPIPv4No”udp4”
NetworkTypeUDP6UDPIPv6No”udp6”
NetworkTypeTCP4TCPIPv4Yes”tcp4”
NetworkTypeTCP6TCPIPv6Yes”tcp6”

Build docs developers (and LLMs) love

Get started for freeTalk to us