nl :: Inet :: UDPEndPoint

#include <src/inet/UDPEndPoint.h>

Các đối tượng của lớp này đại diện cho các điểm cuối truyền tải UDP.

Tóm lược

Lớp Nest Inet đóng gói các phương thức tương tác với các điểm cuối truyền tải UDP (ổ cắm SOCK_DGRAM trên hệ thống dẫn xuất Linux và BSD) hoặc các khối điều khiển giao thức LwIP UDP, khi hệ thống được định cấu hình phù hợp.

Di sản

Kế thừa từ: nl :: Inet :: IPEndPointBasis

Chức năng công cộng
`Bind (IPAddressType addrType, IPAddress addr, uint16_t port, InterfaceId intfId)`	`INET_ERROR` Liên kết điểm cuối với một địa chỉ IP giao diện.
`BindInterface (IPAddressType addrType, InterfaceId intf)`	`INET_ERROR` Liên kết điểm cuối với giao diện mạng.
`Close (void)`	`void` Đóng điểm cuối.
`Free (void)`	`void` Đóng điểm cuối và tái chế bộ nhớ của nó.
`GetBoundInterface (void)`	`InterfaceId` Nhận giao diện ràng buộc trên điểm cuối này.
`GetBoundPort (void)`	`uint16_t`
`Listen (void)`	`INET_ERROR` Chuẩn bị điểm cuối để nhận tin nhắn UDP.
`SendMsg (const IPPacketInfo pktInfo, Weave::System::PacketBuffer msg, uint16_t sendFlags)`	`INET_ERROR` Gửi tin nhắn UDP đến một điểm đến được chỉ định.
`SendTo ( IPAddress addr, uint16_t port, Weave::System::PacketBuffer *msg, uint16_t sendFlags)`	`INET_ERROR` Từ đồng nghĩa với `SendTo(addr, port, INET_NULL_INTERFACEID, msg, sendFlags)` .
`SendTo ( IPAddress addr, uint16_t port, InterfaceId intfId, Weave::System::PacketBuffer *msg, uint16_t sendFlags)`	`INET_ERROR` Gửi tin nhắn UDP đến địa chỉ đích đã chỉ định.

Chức năng công cộng

Trói buộc

INET_ERROR Bind(
  IPAddressType addrType,
  IPAddress addr,
  uint16_t port,
  InterfaceId intfId
)

Liên kết điểm cuối với một địa chỉ IP giao diện.

Liên kết điểm cuối với địa chỉ IP giao diện mạng được chỉ định.

Chi tiết

Thông số

`[in] addrType`	phiên bản giao thức của địa chỉ IP
`[in] addr`	địa chỉ IP (phải là địa chỉ giao diện)
`[in] port`	cổng UDP
`[in] intfId`	một chỉ báo giao diện mạng tùy chọn

Giá trị trả lại

`INET_NO_ERROR`	thành công: điểm cuối liên kết với địa chỉ
`INET_ERROR_INCORRECT_STATE`	điểm cuối đã bị ràng buộc trước đây
`INET_NO_MEMORY`	không đủ bộ nhớ cho điểm cuối
`INET_ERROR_UNKNOWN_INTERFACE`	Trên một số nền tảng, giao diện được chỉ định tùy chọn không xuất hiện.
`INET_ERROR_WRONG_PROTOCOL_TYPE`	`addrType` không khớp với `IPVer` .
`INET_ERROR_WRONG_ADDRESS_TYPE`	`addrType` là `kIPAddressType_Any` , hoặc loại `addr` không bằng `addrType` .
`other`	lỗi hệ thống hoặc nền tảng khác

Trên LwIP, phương thức này không được gọi với khóa ngăn xếp LwIP đã có.

BindInterface

INET_ERROR BindInterface(
  IPAddressType addrType,
  InterfaceId intf
)

Liên kết điểm cuối với giao diện mạng.

Liên kết điểm cuối với địa chỉ IP giao diện mạng được chỉ định.

Chi tiết

Thông số

`[in] addrType`	phiên bản giao thức của địa chỉ IP.
`[in] intf`	chỉ báo của giao diện mạng.

Giá trị trả lại

`INET_NO_ERROR`	thành công: điểm cuối liên kết với địa chỉ
`INET_NO_MEMORY`	không đủ bộ nhớ cho điểm cuối
`INET_ERROR_NOT_IMPLEMENTED`	triển khai hệ thống không hoàn chỉnh.
`INET_ERROR_UNKNOWN_INTERFACE`	Trên một số nền tảng, giao diện không hiện diện.
`other`	lỗi hệ thống hoặc nền tảng khác

Trên LwIP, phương thức này không được gọi với khóa ngăn xếp LwIP đã có.

Đóng

void Close(
  void
)

Đóng điểm cuối.

Nếu mState != kState_Closed , thì đóng điểm cuối, xóa nó khỏi tập hợp các điểm cuối đủ điều kiện cho các sự kiện giao tiếp.

Trên hệ thống LwIP, phương thức này không được gọi với khóa ngăn xếp LwIP đã có.

Miễn phí

void Free(
  void
)

Đóng điểm cuối và tái chế bộ nhớ của nó.

Gọi phương thức Close , sau đó gọi phương thức InetLayerBasis::Release để trả đối tượng về vùng nhớ của nó.

Trên hệ thống LwIP, phương thức này không được gọi với khóa ngăn xếp LwIP đã có.

GetBoundInterface

InterfaceId GetBoundInterface(
  void
)

Nhận giao diện ràng buộc trên điểm cuối này.

Chi tiết
Lợi nhuận	InterfaceId Id giao diện liên kết.

GetBoundPort

uint16_t GetBoundPort(
  void
)

Nghe

INET_ERROR Listen(
  void
)

Chuẩn bị điểm cuối để nhận tin nhắn UDP.

Nếu State đã là kState_Listening , thì không có thao tác nào được thực hiện, nếu không thì mState được đặt thành kState_Listening và điểm cuối được chuẩn bị để nhận các thông báo UDP, theo ngữ nghĩa của nền tảng.

Chi tiết

Giá trị trả lại

`INET_NO_ERROR`	thành công: điểm cuối sẵn sàng nhận tin nhắn.
`INET_ERROR_INCORRECT_STATE`	endpoint đã được lắng nghe.

Trên LwIP, phương thức này không được gọi với khóa ngăn xếp LwIP đã có

SendMsg

INET_ERROR SendMsg(
  const IPPacketInfo *pktInfo,
  Weave::System::PacketBuffer *msg,
  uint16_t sendFlags
)

Gửi tin nhắn UDP đến một điểm đến được chỉ định.

 Send the UDP message in \c msg to the destination address and port given in
 \c pktInfo.  If \c pktInfo contains an interface id, the message will be sent
 over the specified interface.  If \c pktInfo contains a source address, the
 given address will be used as the source of the UDP message.

 Where (sendFlags & kSendFlag_RetainBuffer) != 0, calls
 Weave::System::PacketBuffer::Free on behalf of the caller, otherwise this
 method deep-copies \c msg into a fresh object, and queues that for
 transmission, leaving the original \c msg available after return.

Chi tiết

Thông số

`[in] pktInfo`	thông tin nguồn và đích cho thông báo UDP
`[in] msg`	một bộ đệm gói có chứa thông báo UDP
`[in] sendFlags`	cờ tùy chọn truyền tùy chọn

Giá trị trả lại

`INET_NO_ERROR`	thành công: `msg` được xếp hàng đợi để truyền.
`INET_ERROR_NOT_SUPPORTED`	hệ thống không hỗ trợ hoạt động được yêu cầu.
`INET_ERROR_WRONG_ADDRESS_TYPE`	địa chỉ đích và địa chỉ giao diện liên kết không có phiên bản giao thức hoặc loại địa chỉ phù hợp.
`INET_ERROR_MESSAGE_TOO_LONG`	`msg` không chứa toàn bộ thông báo UDP.
`INET_ERROR_OUTBOUND_MESSAGE_TRUNCATED`	Trên một số nền tảng, chỉ một phần `msg` bị cắt ngắn được xếp hàng đợi để truyền.
`other`	lỗi hệ thống hoặc nền tảng khác

Gửi đến

INET_ERROR SendTo(
  IPAddress addr,
  uint16_t port,
  Weave::System::PacketBuffer *msg,
  uint16_t sendFlags
)

Từ đồng nghĩa với SendTo(addr, port, INET_NULL_INTERFACEID, msg, sendFlags) .

Gửi đến

INET_ERROR SendTo(
  IPAddress addr,
  uint16_t port,
  InterfaceId intfId,
  Weave::System::PacketBuffer *msg,
  uint16_t sendFlags
)

Gửi tin nhắn UDP đến địa chỉ đích đã chỉ định.

 If possible, then this method sends the UDP message \c msg to the
 destination \c addr (with \c intfId used as the scope
 identifier for IPv6 link-local destinations) and \c port with the
 transmit option flags encoded in \c sendFlags.

 Where (sendFlags & kSendFlag_RetainBuffer) != 0, calls
 Weave::System::PacketBuffer::Free on behalf of the caller, otherwise this
 method deep-copies \c msg into a fresh object, and queues that for
 transmission, leaving the original \c msg available after return.

Chi tiết

Thông số

`[in] addr`	địa chỉ IP đích
`[in] port`	cổng UDP đích
`[in] intfId`	một chỉ báo giao diện mạng tùy chọn
`[in] msg`	bộ đệm gói chứa thông báo UDP
`[in] sendFlags`	cờ tùy chọn truyền tùy chọn

Giá trị trả lại

`INET_NO_ERROR`	thành công: `msg` được xếp hàng đợi để truyền.
`INET_ERROR_NOT_SUPPORTED`	hệ thống không hỗ trợ hoạt động được yêu cầu.
`INET_ERROR_WRONG_ADDRESS_TYPE`	địa chỉ đích và địa chỉ giao diện liên kết không có phiên bản giao thức hoặc loại địa chỉ phù hợp.
`INET_ERROR_MESSAGE_TOO_LONG`	`msg` không chứa toàn bộ thông báo UDP.
`INET_ERROR_OUTBOUND_MESSAGE_TRUNCATED`	Trên một số nền tảng, chỉ một phần `msg` bị cắt ngắn được xếp hàng đợi để truyền.
`other`	lỗi hệ thống hoặc nền tảng khác