mirrors/cosmopolitan
1
0
Fork 0
mirror of https://github.com/jart/cosmopolitan.git synced 2024-05-04 20:58:47 +00:00
Code Issues Projects Releases Wiki Activity

Update GetRemoteAddr documentation to clarify that it may return nil. (#1149)

Browse source
This commit is contained in:
Paul Kulchenko 2024-04-21 22:55:08 -07:00 committed by GitHub
parent bc6c18368f
commit 01267ea0f5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
tool/net/help.txt
View file

@ -1160,12 +1160,17 @@ FUNCTIONS
>: shared_key1 == shared_key2
true
GetRemoteAddr() → ip:uint32,port:uint16
GetRemoteAddr()
├─→ ip:uint32,port:uint16
└─→ nil
Returns client ip4 address and port, e.g. 0x01020304,31337 would
represent 1.2.3.4:31337. This is the same as GetClientAddr except
it will use the ip:port from the X-Forwarded-For header, only if
IsPrivateIp or IsLoopbackIp return true. When multiple addresses
are present in the header, the last/right-most address is used.
it will use the ip:port from the X-Forwarded-For header when the
IP returned by GetClientAddr is a trusted IP (returns true when
checked against IsTrustedIp). When multiple addresses are present
in the header, the last/right-most address is used.
Returns `nil` if the address doesn't parse as IPv4 value (e.g.
because it is misformatted or an IPv6 address).
GetResponseBody()
├─→ body:str