Класс DatagramSocket

Этот класс представляет сокет для отправки и получения пакетов датаграмм.

Сокет датаграмм — это точка отправки или получения для службы доставки пакетов. Каждый пакет, отправленный или полученный по сокету датаграмм, индивидуально адресован и маршрутизирован. Несколько пакетов, отправленных с одной машины на другую, могут быть маршрутизированы по-разному и могут прибыть в произвольном порядке.

По возможности, только что созданный DatagramSocket имеет включенный параметр сокета SO_BROADCAST для возможности передачи широковещательных датаграмм. Для получения широковещательных пакетов сокет DatagramSocket должен быть привязан к универсальному адресу. В некоторых реализациях широковещательные пакеты также могут быть получены, когда DatagramSocket привязан к более конкретному адресу.

Пример: DatagramSocket s = new DatagramSocket(null); s.bind(new InetSocketAddress(8888)); что эквивалентно: DatagramSocket s = new DatagramSocket(8888); Оба случая создадут сокет DatagramSocket, способный принимать широковещательные данные на UDP-порту 8888.

Конструкторы

DatagramSocket

public DatagramSocket()
               throws SocketException

Исключения:

SocketException - если сокет не может быть открыт или привязан к указанному локальному порту.

SecurityException - если менеджер безопасности существует и его метод checkListen не разрешает операцию.

См. также:

SecurityManager.checkListen(int)

DatagramSocket

protected DatagramSocket(DatagramSocketImpl impl)

Создаёт не привязанный сокет для работы с датаграммами с указанным DatagramSocketImpl.

Параметры:

impl - экземпляр DatagramSocketImpl, который подкласс желает использовать в DatagramSocket.

С тех пор:

1.4

DatagramSocket

public DatagramSocket(SocketAddress bindaddr)
               throws SocketException

Параметры:

bindaddr - локальный адрес сокета для привязки, или null для не привязанного сокета.

Исключения:

SocketException - если сокет не может быть открыт или привязан к указанному локальному порту.

SecurityException - если менеджер безопасности существует и его метод checkListen не разрешает операцию.

С тех пор:

1.4

См. также:

SecurityManager.checkListen(int)

DatagramSocket

public DatagramSocket(int port)
               throws SocketException

Параметры:

port - используемый порт.

Исключения:

SocketException - если сокет не может быть открыт или привязан к указанному локальному порту.

SecurityException - если менеджер безопасности существует и его метод checkListen не разрешает операцию.

См. также:

SecurityManager.checkListen(int)

DatagramSocket

public DatagramSocket(int port,
                      InetAddress laddr)
               throws SocketException

Параметры:

port - используемый локальный порт

laddr - локальный адрес для привязки

Исключения:

SocketException - если сокет не может быть открыт или привязан к указанному локальному порту.

SecurityException - если менеджер безопасности существует и его метод checkListen не разрешает операцию.

С тех пор:

JDK1.1

См. также:

SecurityManager.checkListen(int)

Методы

bind

public void bind(SocketAddress addr)
          throws SocketException

Параметры:

addr - адрес и порт для привязки.

Исключения:

SocketException - если произошла ошибка при привязке, или сокет уже привязан.

SecurityException - если менеджер безопасности существует и его метод checkListen не разрешает операцию.

IllegalArgumentException - если addr — подкласс SocketAddress, не поддерживаемый этим сокетом.

С тех пор:

1.4

connect

public void connect(InetAddress address,
                    int port)

Параметры:

address - удалённый адрес для сокета

port - удалённый порт для сокета.

Исключения:

IllegalArgumentException - если адрес null, или порт вне диапазона.

SecurityException - если установлен менеджер безопасности и он не разрешает доступ к данному удалённому адресу

См. также:

disconnect()

connect

public void connect(SocketAddress addr)
             throws SocketException

Параметры:

addr - удалённый адрес.

Исключения:

SocketException - если подключение не удалось

IllegalArgumentException - если addr является null, или addr — подкласс SocketAddress, не поддерживаемый этим сокетом

SecurityException - если установлен менеджер безопасности и он не разрешает доступ к данному удалённому адресу

С тех пор:

1.4

disconnect

public void disconnect()

Отключает сокет. Если сокет закрыт или не подключён, этот метод не оказывает влияния.

См. также:

connect(java.net.InetAddress, int)

isBound

public boolean isBound()

Возвращает:

true, если сокет успешно привязан к адресу

С тех пор:

1.4

isConnected

public boolean isConnected()

Возвращает:

true, если сокет успешно подключён к серверу

С тех пор:

1.4

getInetAddress

public InetAddress getInetAddress()

Возвращает:

адрес, к которому подключён этот сокет.

getPort

public int getPort()

Возвращает:

номер порта, к которому подключён этот сокет.

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Возвращает:

a SocketAddress представляющий удалённый конечный пункт этого сокета, или null если он ещё не подключён.

С момента:

1.4

См. также:

getInetAddress(), getPort(), connect(SocketAddress)

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Возвращает адрес конечной точки, к которой привязан этот сокет.

Возвращает:

a SocketAddress представляющий локальный конечный пункт этого сокета, или null если он закрыт или ещё не привязан.

С момента:

1.4

См. также:

getLocalAddress(), getLocalPort(), bind(SocketAddress)

send

public void send(DatagramPacket p)
          throws IOException

Параметры:

p - отправляемый DatagramPacket.

Исключения:

IOException - если произошла ошибка ввода-вывода.

SecurityException - если существует диспетчер безопасности, и его метод checkMulticast или checkConnect не допускает отправки.

PortUnreachableException - может быть выброшено, если сокет подключен к недоступному в данный момент пункту назначения. Обратите внимание, что нет гарантии, что исключение будет выброшено.

IllegalBlockingModeException - если у этого сокета есть связанный канал и он в режиме без ожидания.

IllegalArgumentException - если сокет подключён, и адрес подключения отличается от адреса пакета.

См. также:

DatagramPacket, SecurityManager.checkMulticast(InetAddress), SecurityManager.checkConnect(java.lang.String, int)

receive

public void receive(DatagramPacket p)
             throws IOException

Параметры:

p - DatagramPacket для размещения входящих данных.

Исключения:

IOException - если произошла ошибка ввода-вывода.

SocketTimeoutException - если ранее был вызван метод setSoTimeout и таймаут истек.

PortUnreachableException - может быть выброшено, если сокет подключён к недоступному в данный момент пункту назначения. Обратите внимание, что нет гарантии, что исключение будет выброшено.

IllegalBlockingModeException - если у этого сокета есть связанный канал и он в режиме без ожидания.

См. также:

DatagramPacket, DatagramSocket

getLocalAddress

public InetAddress getLocalAddress()

Возвращает:

локальный адрес, к которому привязан сокет, null если сокет закрыт, или InetAddress представляющий wildcard адрес, если сокет не привязан или метод checkConnect диспетчера безопасности не разрешает операцию

С момента:

1.1

См. также:

SecurityManager.checkConnect(java.lang.String, int)

getLocalPort

public int getLocalPort()

Возвращает номер порта на локальном узле, к которому привязан этот сокет.

Возвращает:

номер порта на локальном узле, к которому привязан этот сокет, -1 если сокет закрыт, или 0 если он ещё не привязан.

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Включает/выключает SO_TIMEOUT с указанным таймаутом в миллисекундах. При ненулевом таймауте вызов receive() для этого DatagramSocket будет блокироваться только на это время. Если таймаут истечёт, будет возбуждено исключение java.net.SocketTimeoutException, хотя DatagramSocket останется действительным. Опция должна быть включена до начала блокирующей операции, чтобы иметь эффект. Таймаут должен быть > 0. Таймаут 0 интерпретируется как бесконечный таймаут.

Параметры:

timeout - указанный таймаут в миллисекундах.

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

С момента:

JDK1.1

См. также:

getSoTimeout()

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Получить значение настройки SO_TIMEOUT. 0 означает, что опция отключена (т.е. таймаут бесконечен).

Возвращает:

значение настройки SO_TIMEOUT

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

С момента:

JDK1.1

См. также:

setSoTimeout(int)

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Параметры:

size - размер, на который нужно установить размер буфера отправки. Это значение должно быть больше 0.

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

IllegalArgumentException - если значение равно 0 или отрицательно.

См. также:

getSendBufferSize()

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Получить значение опции SO_SNDBUF для этого DatagramSocket, то есть размер буфера, используемого платформой для вывода по этому DatagramSocket.

Возвращает:

значение опции SO_SNDBUF для этого DatagramSocket

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

См. также:

setSendBufferSize(int)

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Параметры:

size - размер, на который нужно установить размер буфера приёма. Это значение должно быть больше 0.

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

IllegalArgumentException - если значение равно 0 или отрицательно.

См. также:

getReceiveBufferSize()

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Получить значение опции SO_RCVBUF для этого DatagramSocket, то есть размер буфера, используемого платформой для ввода по этому DatagramSocket.

Возвращает:

значение опции SO_RCVBUF для этого DatagramSocket

Исключения:

SocketException - если возникла ошибка в базовом протоколе, например, ошибка UDP.

См. также:

setReceiveBufferSize(int)

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Параметры:

on - включить или отключить опцию

Исключения:

SocketException - если произошла ошибка при включении или отключении опции сокета SO_RESUEADDR, или сокет закрыт.

С момента:

1.4

См. также:

getReuseAddress(), bind(SocketAddress), isBound(), isClosed()

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Проверяет, включена ли опция SO_REUSEADDR.

Возвращает:

значение boolean, указывающее, включена ли опция SO_REUSEADDR.

Исключения:

SocketException - если произошла ошибка в базовом протоколе, например, ошибка UDP.

С момента:

1.4

См. также:

setReuseAddress(boolean)

setBroadcast

public void setBroadcast(boolean on)
                  throws SocketException

Параметры:

on - требуется ли включить широковещательный режим.

Исключения:

SocketException - если произошла ошибка в базовом протоколе, например, ошибка UDP.

С момента:

1.4

См. также:

getBroadcast()

getBroadcast

public boolean getBroadcast()
                     throws SocketException

Проверяет, включена ли опция SO_BROADCAST.

Возвращает:

значение boolean, указывающее, включена ли опция SO_BROADCAST.

Исключения:

SocketException - если произошла ошибка в базовом протоколе, например, ошибка UDP.

С момента:

1.4

См. также:

setBroadcast(boolean)

setTrafficClass

public void setTrafficClass(int tc)
                     throws SocketException

Параметры:

tc - значение int для набора битов.

Исключения:

SocketException - если произошла ошибка при установке класса трафика или типа обслуживания

С момента:

1.4

См. также:

getTrafficClass()

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Возвращает:

установленный класс трафика или тип обслуживания

Исключения:

SocketException - если произошла ошибка при получении значения класса трафика или типа обслуживания.

С момента:

1.4

См. также:

setTrafficClass(int)

close

public void close()

Определено в:

close в интерфейсе Closeable

Определено в:

close в интерфейсе AutoCloseable

isClosed

public boolean isClosed()

Возвращает, закрыт ли сокет.

Возвращает:

true, если сокет закрыт

С момента:

1.4

getChannel

public DatagramChannel getChannel()

Возвращает:

канал датаграмм, связанный с этим сокетом датаграмм, или null если этот сокет не был создан для канала

С момента:

1.4

setDatagramSocketImplFactory

public static void setDatagramSocketImplFactory(DatagramSocketImplFactory fac)
                                         throws IOException

Параметры:

fac - желаемая фабрика.

Исключения:

IOException - если при установке фабрики сокета датаграмм произошла ошибка ввода-вывода.

SocketException - если фабрика уже определена.

SecurityException - если менеджер безопасности существует и его метод checkSetFactory не разрешает операцию.

С момента:

1.3

См. также:

DatagramSocketImplFactory.createDatagramSocketImpl(), SecurityManager.checkSetFactory()