nl:: Inet
สรุป
Typedef |
|
---|---|
InterfaceId
|
typedefstruct netif *
สัญญาณบอกสถานะสำหรับอินเทอร์เฟซเครือข่ายของระบบ |
ตัวแปร |
|
---|---|
sIOCTLSocket = -1
|
int
|
ฟังก์ชัน |
|
---|---|
CheckMulticastGroupArgs(InterfaceId aInterfaceId, const IPAddress & aAddress)
|
|
CloseIOCTLSocket(void)
|
void
ปิดซ็อกเก็ตส่วนกลางที่สร้างโดย
GetIOCTLSocket |
FormatInetLayerError(char *buf, uint16_t bufSize, int32_t err)
|
bool
เนื่องจากข้อผิดพลาดของ Inet Layer จะแสดงผลสตริง C ที่สิ้นสุดด้วยค่า Null ที่มนุษย์อ่านได้และอธิบายถึงข้อผิดพลาดดังกล่าว
|
GetIOCTLSocket(void)
|
int
แสดงผลซ็อกเก็ตอเนกประสงค์ทั่วโลกซึ่งมีประโยชน์สำหรับการเรียกใช้ IOCTL ของเครือข่ายบางรายการ
|
GetInterfaceName(InterfaceId intfId, char *nameBuf, size_t nameBufSize)
|
NL_DLL_EXPORT INET_ERROR
รับชื่ออินเทอร์เฟซเครือข่าย
|
INET_IsInetEvent(Weave::System::EventType aType)
|
bool
ตรวจสอบว่า System::EventType เป็นประเภทเหตุการณ์เลเยอร์ Inet ที่ถูกต้องหรือไม่
|
InterfaceNameToId(const char *intfName, InterfaceId & intfId)
|
NL_DLL_EXPORT INET_ERROR
ค้นหาชื่อที่ระบุในรายการอินเทอร์เฟซเครือข่าย
|
LwIPBindInterface(struct raw_pcb *aRaw, InterfaceId intfId)
|
|
LwIPBindInterface(struct udp_pcb *aUDP, InterfaceId intfId)
|
|
NetmaskToPrefixLength(const uint8_t *netmask, uint16_t netmaskLen)
|
uint8_t
คำนวณความยาวของคำนำหน้าจากเน็ตมาสก์ที่มีความยาวแปรผัน
|
ParseHostAndPort(const char *aString, uint16_t aStringLen, const char *& aHost, uint16_t & aHostLen, uint16_t & aPort)
|
แยกวิเคราะห์สตริงที่มนุษย์อ่านได้ซึ่งมีโฮสต์หรือที่อยู่ IP และหมายเลขพอร์ตที่ไม่บังคับ (คั่นด้วย ":") ซึ่งรองรับรูปแบบต่อไปนี้
|
ParseHostPortAndInterface(const char *aString, uint16_t aStringLen, const char *& aHost, uint16_t & aHostLen, uint16_t & aPort, const char *& aInterface, uint16_t & aInterfaceLen)
|
แยกวิเคราะห์สตริงที่มนุษย์อ่านได้ซึ่งมีโฮสต์หรือที่อยู่ IP, หมายเลขพอร์ตที่ไม่บังคับ (คั่นด้วย ":") และชื่ออินเทอร์เฟซที่ไม่บังคับ (คั่นด้วยเครื่องหมาย '') ซึ่งรองรับรูปแบบต่อไปนี้
|
RegisterInetLayerErrorFormatter(void)
|
void
ลงทะเบียนตัวจัดรูปแบบข้อผิดพลาดข้อความสำหรับข้อผิดพลาดของเลเยอร์ Inet
|
SocketsIPv4JoinLeaveMulticastGroup(int aSocket, InterfaceId aInterfaceId, const IPAddress & aAddress, int aCommand)
|
|
SocketsIPv6JoinLeaveMulticastGroup(int aSocket, InterfaceId aInterfaceId, const IPAddress & aAddress, int aCommand)
|
|
SocketsSetMulticastLoopback(int aSocket, bool aLoopback, int aProtocol, int aOption)
|
|
SocketsSetMulticastLoopback(int aSocket, IPVersion aIPVersion, bool aLoopback)
|
คลาส |
|
---|---|
nl:: |
นี่คือคลาสภายในของ InetLayer ที่มี API ตัวช่วยสำหรับการแปลงชื่อ Asynchronous Domain Name System (DNS) ใน InetLayer |
nl:: |
ซึ่งเป็นคลาสภายในของ InetLayer ที่มอบ Abstraction ของการแปลงระบบชื่อโดเมน (DNS) ใน InetLayer |
nl:: |
พื้นฐานของคลาสปลายทางการขนส่งทางอินเทอร์เน็ต |
nl:: |
ที่อยู่ Internet Protocol |
nl:: |
ออบเจ็กต์ของคลาสนี้แสดงปลายทางโปรโตคอล IP ที่ไม่สามารถยืนยันได้ |
nl:: |
ข้อมูลเกี่ยวกับข้อความขาเข้า/ขาออก/การเชื่อมต่อ |
nl:: |
คำนำหน้าที่อยู่ Internet Protocol |
nl:: |
ซึ่งจะทำให้เข้าถึงบริการอินเทอร์เน็ตต่างๆ ได้ ไม่ว่าจะเป็นตัวจับเวลา, การแปลงชื่อโดเมน (DNS), การรับส่งข้อมูลเครือข่าย TCP, การส่งเครือข่าย UDP และการส่งเครือข่ายแบบ RAW สำหรับเทรดเดียว |
nl:: |
นี่คือคลาสพื้นฐานของออบเจ็กต์ที่นับจำนวนอ้างอิงที่จัดการโดยออบเจ็กต์ InetLayer |
nl:: |
Iterator สำหรับรายการที่อยู่ IP ของอินเทอร์เฟซเครือข่ายของระบบ |
nl:: |
Iterator สำหรับรายการอินเทอร์เฟซเครือข่ายของระบบ |
nl:: |
ออบเจ็กต์ของคลาสนี้แสดงปลายทางเครือข่าย IP ดิบ |
nl:: |
แสดงชุดเหตุการณ์ I/O ที่ขอ/ขึ้นอยู่กับซ็อกเก็ต |
nl:: |
ออบเจ็กต์ของคลาสนี้แสดงปลายทางการรับส่ง TCP |
nl:: |
ออบเจ็กต์ของคลาสนี้แสดงอินเทอร์เฟซของทันเนล |
nl:: |
ออบเจ็กต์ของคลาสนี้แสดงปลายทางการรับส่ง UDP |
สหภาพ |
|
---|---|
nl:: |
เนมสเปซ |
|
---|---|
nl:: |
การแจกแจง
@7
@7
คําจํากัดความของประเภทเหตุการณ์เลเยอร์ Inet
พร็อพเพอร์ตี้ | |
---|---|
kInetEvent_DNSResolveComplete
|
เหตุการณ์สำหรับการแปลงชื่อ DNS เสร็จสมบูรณ์ |
kInetEvent_RawDataReceived
|
เหตุการณ์การรับข้อมูลผ่านปลายทางดิบของ InetLayer |
kInetEvent_TCPConnectComplete
|
เหตุการณ์สำหรับการเชื่อมต่อ TCP เสร็จสมบูรณ์ |
kInetEvent_TCPConnectionReceived
|
เหตุการณ์สำหรับการรับการเชื่อมต่อ TCP |
kInetEvent_TCPDataReceived
|
เหตุการณ์สำหรับการรับข้อมูลผ่านการเชื่อมต่อ TCP |
kInetEvent_TCPDataSent
|
เหตุการณ์สำหรับการส่งข้อมูลผ่านการเชื่อมต่อ TCP |
kInetEvent_TCPError
|
เหตุการณ์ที่มีข้อผิดพลาดในการเชื่อมต่อ TCP |
kInetEvent_TunDataReceived
|
เหตุการณ์การรับข้อมูลผ่านอุโมงค์ Weave |
kInetEvent_UDPDataReceived
|
เหตุการณ์การรับข้อมูลผ่าน UDP |
DNSOptions
DNSOptions
ตัวเลือกการควบคุมความละเอียดของที่อยู่ IP
พร็อพเพอร์ตี้ | |
---|---|
kDNSOption_AddrFamily_Any
|
แสดงผลที่อยู่ IPv4 และ/หรือ IPv6 ในลำดับที่ Nameserver แสดงผล |
kDNSOption_AddrFamily_IPv4Only
|
แสดงเฉพาะที่อยู่ IPv4 |
kDNSOption_AddrFamily_IPv4Preferred
|
แสดงที่อยู่ IPv4 และ/หรือ IPv6 โดยที่มีที่อยู่ IPv4 เป็นอันดับแรก |
kDNSOption_AddrFamily_IPv6Only
|
แสดงเฉพาะที่อยู่ IPv6 |
kDNSOption_AddrFamily_IPv6Preferred
|
แสดงผลที่อยู่ IPv4 และ/หรือ IPv6 โดยให้ที่อยู่ IPv6 แสดงก่อน |
kDNSOption_AddrFamily_Mask
|
บิตภายในค่าจำนวนเต็ม DNSOptions ซึ่งแสดงกลุ่มที่อยู่ที่ต้องการ |
kDNSOption_Flags_Mask
|
บิตภายในค่าจำนวนเต็ม DNSOptions ที่สงวนไว้สําหรับแฟล็ก |
kDNSOption_ValidFlags
|
ชุดแฟล็ก DNSOption ที่ถูกต้องทั้งหมด |
IPAddressType
IPAddressType
กลุ่มที่อยู่ของ Internet Protocol
ค่าของประเภท IPAddressType
จะแสดงผลโดยเมธอด IPAddress::Type()
รหัสดังกล่าวจะระบุกลุ่มที่อยู่ที่เกี่ยวข้องกับการใช้ที่อยู่
พร็อพเพอร์ตี้ | |
---|---|
kIPAddressType_Any
|
ที่อยู่อินเทอร์เน็ตที่ไม่ระบุ (ไม่ขึ้นอยู่กับเวอร์ชันโปรโตคอล) |
kIPAddressType_IPv4
|
Internet Protocol เวอร์ชัน 4 |
kIPAddressType_IPv6
|
Internet Protocol เวอร์ชัน 6 |
kIPAddressType_Unknown
|
ไม่ใช้ |
IPProtocol
IPProtocol
จำนวนของโปรโตคอลบางรายการในกลุ่ม IP
พร็อพเพอร์ตี้ | |
---|---|
kIPProtocol_ICMPv4
|
ICMPv4 |
kIPProtocol_ICMPv6
|
ICMPv6 |
IPV6MulticastGroup
IPV6MulticastGroup
ตัวระบุกลุ่มมัลติแคสต์สำหรับอินเทอร์เน็ตโปรโตคอล
ค่าของประเภท IPV6MulticastGroup
จะใช้ในการเรียกใช้เมธอด IPAddress::MakeIPv6Multicast()
โดยเป็นตัวระบุตัวระบุกลุ่มที่จดทะเบียนโดย IETF กับ IANA
พร็อพเพอร์ตี้ | |
---|---|
kIPV6MulticastGroup_AllRouters
|
RFC 4291 |
IPVersion
IPVersion
เวอร์ชันของโปรโตคอล IP ที่ใช้อยู่
พร็อพเพอร์ตี้ | |
---|---|
kIPVersion_4
|
IPv4 |
kIPVersion_6
|
IPv6 |
IPv6MulticastFlag
IPv6MulticastFlag
การตั้งค่าสถานะมัลติแคสต์ Internet Protocol v6
ค่าของประเภท IPv6MulticastFlag
จะใช้ในการเรียกใช้เมธอด IPAddress::MakeIPv6Multicast()
ซึ่งจะระบุประเภทของที่อยู่ IPv6 แบบมัลติแคสต์ที่จะสร้าง หมายเลขเหล่านี้จดทะเบียนกับ IETF กับ IANA
พร็อพเพอร์ตี้ | |
---|---|
kIPv6MulticastFlag_Prefix
|
ที่อยู่มัลติแคสต์คือ (1) ตามคำนำหน้าเครือข่าย |
kIPv6MulticastFlag_Transient
|
ที่อยู่มัลติแคสต์นั้นเป็น (1) ชั่วคราว (กำหนดแบบไดนามิก) ไม่ใช่ (0) เป็นที่รู้จัก (เช่น กำหนดโดย IANA) |
IPv6MulticastScope
IPv6MulticastScope
ขอบเขตที่อยู่มัลติแคสต์ของอินเทอร์เน็ตโปรโตคอล
ค่าของประเภท IPv6MulticastScope
จะใช้ในการเรียกใช้เมธอด IPAddress::MakeIPv6Multicast()
พารามิเตอร์จะระบุขอบเขตที่กำหนดเส้นทางได้ของกลุ่มมัลติแคสต์ที่กำหนดโดยผลลัพธ์ หมายเลขเหล่านี้จดทะเบียนกับ IETF กับ IANA
พร็อพเพอร์ตี้ | |
---|---|
kIPv6MulticastScope_Admin
|
ขอบเขต Realm-local |
kIPv6MulticastScope_Global
|
ขอบเขตรวมทั้งหมด |
kIPv6MulticastScope_IPv4
|
ขอบเขต Realm-local ("IPv4") |
kIPv6MulticastScope_Interface
|
ขอบเขตของอินเทอร์เฟซภายใน |
kIPv6MulticastScope_Link
|
ขอบเขตของลิงก์ภายใน |
kIPv6MulticastScope_Organization
|
ขอบเขตระดับองค์กร |
kIPv6MulticastScope_Site
|
ขอบเขต Realm-local |
Typedef
InterfaceId
struct netif * InterfaceId
สัญญาณบอกสถานะสำหรับอินเทอร์เฟซเครือข่ายของระบบ
การถ่ายโอนได้ขึ้นอยู่กับการไม่เคยเห็นชื่อแทนนี้ ในอนาคตอาจใช้ชั้นคอนกรีตทึบแสงแทน
หมายเหตุ: คำว่า "รหัสระบุอินเทอร์เฟซ" ตามหลักแล้วยังหมายถึง 64 บิตที่ต่ำกว่าของที่อยู่ IPv6 ในเอกสารมาตรฐาน IETF ที่เกี่ยวข้องทั้งหมด ซึ่งตัวย่อ "IID" ที่มักใช้กันคือ ในข้อความนี้ คำว่า "ตัวบ่งชี้อินเทอร์เฟซ" หมายถึงค่าของชื่อแทนประเภทนี้
ตัวแปร
sIOCTLSocket
int sIOCTLSocket = -1
ฟังก์ชัน
CheckMulticastGroupArgs
INET_ERROR CheckMulticastGroupArgs( InterfaceId aInterfaceId, const IPAddress & aAddress )
CloseIOCTLSocket
void CloseIOCTLSocket( void )
ปิดซ็อกเก็ตส่วนกลางที่สร้างโดย GetIOCTLSocket
ฟังก์ชันนี้มีไว้สำหรับกรณีต่างๆ ที่เปิดซ็อกเก็ต IOCTL ทั่วโลกไว้จะถือเป็นการรั่วไหล
หมายเหตุ: ฟังก์ชันนี้ไม่ปลอดภัยชุดข้อความที่เกี่ยวข้องกับ GetIOCTLSocket
FormatInetLayerError
bool FormatInetLayerError( char *buf, uint16_t bufSize, int32_t err )
เนื่องจากข้อผิดพลาดของ Inet Layer จะแสดงผลสตริง C ที่สิ้นสุดด้วยค่า Null ที่มนุษย์อ่านได้และอธิบายถึงข้อผิดพลาดดังกล่าว
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
การส่งคืน |
true หากมีการเขียนสตริงคำอธิบายลงในบัฟเฟอร์ที่ให้ไว้
|
||||||
การส่งคืน |
false หากข้อผิดพลาดที่ระบุไม่ใช่ข้อผิดพลาดของ Inet Layer
|
GetIOCTLSocket
int GetIOCTLSocket( void )
แสดงผลซ็อกเก็ตอเนกประสงค์ทั่วโลกซึ่งมีประโยชน์สำหรับการเรียกใช้ IOCTL ของเครือข่ายบางรายการ
ฟังก์ชันนี้ปลอดภัยกับชุดข้อความในทุกแพลตฟอร์ม
GetInterfaceName
NL_DLL_EXPORT INET_ERROR GetInterfaceName( InterfaceId intfId, char *nameBuf, size_t nameBufSize )
รับชื่ออินเทอร์เฟซเครือข่าย
Writes the name of the network interface as \c NUL terminated text string at \c nameBuf. The name of the unspecified network interface is the empty string.
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
แสดงผลค่า |
|
INET_IsInetEvent
bool INET_IsInetEvent( Weave::System::EventType aType )
ตรวจสอบว่า System::EventType เป็นประเภทเหตุการณ์เลเยอร์ Inet ที่ถูกต้องหรือไม่
รายละเอียด | |||
---|---|---|---|
พารามิเตอร์ |
|
||
การส่งคืน |
true หากอยู่ภายในช่วงที่ระบุ มิเช่นนั้นให้เป็นเท็จ
|
InterfaceNameToId
NL_DLL_EXPORT INET_ERROR InterfaceNameToId( const char *intfName, InterfaceId & intfId )
ค้นหาชื่อที่ระบุในรายการอินเทอร์เฟซเครือข่าย
On LwIP, this function must be called with the LwIP stack lock acquired. The \c intfId parameter is not updated unless the value returned is \c INET_NO_ERROR. It should be initialized with \c INET_NULL_INTERFACEID before calling this function.
รายละเอียด | |||||||
---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||
แสดงผลค่า |
|
LwIPBindInterface
INET_ERROR LwIPBindInterface( struct raw_pcb *aRaw, InterfaceId intfId )
LwIPBindInterface
INET_ERROR LwIPBindInterface( struct udp_pcb *aUDP, InterfaceId intfId )
NetmaskToPrefixLength
uint8_t NetmaskToPrefixLength( const uint8_t *netmask, uint16_t netmaskLen )
คำนวณความยาวของคำนำหน้าจากเน็ตมาสก์ที่มีความยาวแปรผัน
ParseHostAndPort
INET_ERROR ParseHostAndPort( const char *aString, uint16_t aStringLen, const char *& aHost, uint16_t & aHostLen, uint16_t & aPort )
แยกวิเคราะห์สตริงที่มนุษย์อ่านได้ซึ่งมีโฮสต์หรือที่อยู่ IP และหมายเลขพอร์ตที่ไม่บังคับ (คั่นด้วย ":") ซึ่งรองรับรูปแบบต่อไปนี้
: : - [
]:
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||
การส่งคืน |
INET_ERROR_INVALID_HOST_NAME หากอินพุตที่จะแยกวิเคราะห์มีความยาวเป็น 0 หรือมีรูปแบบไม่ถูกต้อง
|
||||||||||
การส่งคืน |
INET_ERROR_HOST_NAME_TOO_LONG หากชื่อโฮสต์มีอักขระเกิน 253 ตัว
|
||||||||||
การส่งคืน |
INET_NO_ERROR สำเร็จแล้ว
|
ParseHostPortAndInterface
INET_ERROR ParseHostPortAndInterface( const char *aString, uint16_t aStringLen, const char *& aHost, uint16_t & aHostLen, uint16_t & aPort, const char *& aInterface, uint16_t & aInterfaceLen )
แยกวิเคราะห์สตริงที่มนุษย์อ่านได้ซึ่งมีโฮสต์หรือที่อยู่ IP, หมายเลขพอร์ตที่ไม่บังคับ (คั่นด้วย ":") และชื่ออินเทอร์เฟซที่ไม่บังคับ (คั่นด้วยเครื่องหมาย '') ซึ่งรองรับรูปแบบต่อไปนี้
% : : % % : : % % - [
]: - [
]: %
รายละเอียด | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||||||
การส่งคืน |
INET_ERROR_INVALID_HOST_NAME หากอินพุตที่จะแยกวิเคราะห์มีความยาวเป็น 0 หรือมีรูปแบบไม่ถูกต้อง
|
||||||||||||||
การส่งคืน |
INET_ERROR_HOST_NAME_TOO_LONG หากชื่อโฮสต์มีอักขระเกิน 253 ตัว
|
||||||||||||||
การส่งคืน |
INET_NO_ERROR สำเร็จแล้ว
|
RegisterInetLayerErrorFormatter
void RegisterInetLayerErrorFormatter( void )
ลงทะเบียนตัวจัดรูปแบบข้อผิดพลาดข้อความสำหรับข้อผิดพลาดของเลเยอร์ Inet
SocketsIPv4JoinLeaveMulticastGroup
INET_ERROR SocketsIPv4JoinLeaveMulticastGroup( int aSocket, InterfaceId aInterfaceId, const IPAddress & aAddress, int aCommand )
SocketsIPv6JoinLeaveMulticastGroup
INET_ERROR SocketsIPv6JoinLeaveMulticastGroup( int aSocket, InterfaceId aInterfaceId, const IPAddress & aAddress, int aCommand )
SocketsSetMulticastLoopback
INET_ERROR SocketsSetMulticastLoopback( int aSocket, bool aLoopback, int aProtocol, int aOption )
SocketsSetMulticastLoopback
INET_ERROR SocketsSetMulticastLoopback( int aSocket, IPVersion aIPVersion, bool aLoopback )