Thanks to visit codestin.com
Credit goes to github.com

Skip to content

socket: fix typespecs #9379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kikofernandez merged 4 commits into from
Feb 6, 2025
Merged

socket: fix typespecs #9379

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b24b108
socket: fix typespecs
kikofernandez Feb 3, 2025
7b6123e
socket: infinity | non_neg replaced by timeout()
kikofernandez Feb 4, 2025
7f1416f
socket: improve type specs as per convention
kikofernandez Feb 4, 2025
ad9f3e8
socket: fix spec of sendto
kikofernandez Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 15 additions & 28 deletions lib/kernel/src/socket.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3190,13 +3190,9 @@ listen(Socket, Backlog) ->
-doc("Equivalent to [`accept(ListenSocket, infinity)`](`accept/2`).").
-spec accept(ListenSocket) -> Result when
Result :: {'ok', Socket} |
{'select', SelectInfo} |
{'completion', CompletionInfo} |
{'error', Reason},
ListenSocket :: socket(),
Socket :: socket(),
SelectInfo :: select_info(),
CompletionInfo :: completion_info(),
Reason :: dynamic().


Expand Down Expand Up @@ -3763,21 +3759,11 @@ an explanation of `TimeoutOrHandle`.
""".

-spec sendto(Socket :: socket(), Data :: iodata(),
Dest :: sockaddr(), Flags | TimeoutOrHandle) -> Result when
TimeoutOrHandle :: dynamic(),
Flags :: list(),
Result :: 'ok'
| {'ok', RestData :: binary()}
| {'error', Reason}
| {'error', {Reason, RestData :: binary()}},
Reason :: posix() | 'closed' | invalid();
Dest :: sockaddr(), Flags :: [msg_flag() | integer()]) -> dynamic();
(Socket :: socket(), Data :: iodata(),
Cont :: select_info(), TimeoutOrHandle :: dynamic()) -> Result when
Result :: 'ok'
| {'ok', RestData :: binary()}
| {'error', Reason}
| {'error', {Reason, RestData :: binary()}},
Reason :: posix() | 'closed' | invalid().
Cont :: select_info(), Timeout :: timeout() | 'nowait' | Handle :: select_handle()) -> dynamic();
(Socket :: socket(), Data :: iodata(),
Dest :: sockaddr(), Timeout :: timeout() | 'nowait' | Handle :: select_handle() | completion_handle()) -> dynamic().

sendto(Socket, Data, Dest, Flags) when is_list(Flags) ->
sendto(Socket, Data, Dest, Flags, ?ESOCK_SENDTO_TIMEOUT_DEFAULT);
Expand Down Expand Up @@ -4880,7 +4866,7 @@ With argument `Length`; equivalent to
With argument `Flags`; equivalent to
[`recv(Socket, 0, Flags, infinity)`](`recv/4`) *(since OTP 24.0)*.
""".
-spec recv(Socket :: socket(), Flags :: list()) -> dynamic();
-spec recv(Socket :: socket(), Flags :: [msg_flag() | integer()]) -> dynamic();
(Socket :: socket(), Length :: non_neg_integer()) -> dynamic().

recv(Socket, Flags) when is_list(Flags) ->
Expand Down Expand Up @@ -4909,12 +4895,12 @@ With arguments `Flags` and `TimeoutOrHandle`; equivalent to
""".
-spec recv(Socket, Flags, TimeoutOrHandle) -> dynamic() when
Socket :: socket(),
Flags :: list(),
TimeoutOrHandle :: nowait | select_handle() | completion_handle();
(Socket :: socket(), Length :: non_neg_integer(), Flags :: list())
Flags :: [msg_flag() | integer()],
TimeoutOrHandle :: timeout() | 'nowait' | select_handle() | completion_handle();
(Socket :: socket(), Length :: non_neg_integer(), Flags :: [msg_flag() | integer()])
-> dynamic();
(Socket :: socket(), Length :: non_neg_integer(), TimeoutOrHandle :: select_handle() | completion_handle())
-> dynamic().
(Socket :: socket(), Length :: non_neg_integer(), TimeoutOrHandle) -> dynamic() when
TimeoutOrHandle :: timeout() | 'nowait' | select_handle() | completion_handle().

recv(Socket, Flags, TimeoutOrHandle) when is_list(Flags) ->
recv(Socket, 0, Flags, TimeoutOrHandle);
Expand Down Expand Up @@ -5346,9 +5332,8 @@ With arguments `Flags` and `TimeoutOrHandle`; equivalent to
-> dynamic();
(Socket :: socket(), BufSz :: non_neg_integer(), Flags :: [msg_flag() | integer()])
-> dynamic();
(Socket :: socket(), BufSz :: non_neg_integer(),
TimeoutOrHandle :: 'nowait' | select_handle() | completion_handle())
-> dynamic().
(Socket :: socket(), BufSz :: non_neg_integer(), TimeoutOrHandle) -> dynamic() when
TimeoutOrHandle :: timeout() | 'nowait' | select_handle() | completion_handle().

recvfrom(Socket, Flags, TimeoutOrHandle) when is_list(Flags) ->
recvfrom(Socket, 0, Flags, TimeoutOrHandle);
Expand Down Expand Up @@ -5553,7 +5538,9 @@ With argument `TimeoutOrHandle`; equivalent to
`TimeoutOrHandle :: Handle` has been allowed *since OTP 24.0*.
""".
-spec recvmsg(Socket :: socket(), Flags :: list()) -> dynamic();
(Socket :: socket(), TimeoutOrHandle :: reference() | 'infinity' | 'nowait' | non_neg_integer()) -> dynamic().
(Socket :: socket(), TimeoutOrHandle) -> dynamic() when
TimeoutOrHandle :: timeout() | 'nowait' | Handle,
Handle :: select_handle() | completion_handle().

recvmsg(Socket, Flags) when is_list(Flags) ->
recvmsg(Socket, 0, 0, Flags, ?ESOCK_RECV_TIMEOUT_DEFAULT);
Expand Down
Loading