[#Sock-Bind]
= xref:Sock.adoc[Sock]::Bind
:relfileprefix: ../
:mrdocs:

bind(2) wrapper. Equivalent to `bind(m_socket, addr, addr_len)`. Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

== Synopsis

Declared in `<util/sock.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
virtual
int
Bind(
    sockaddr const* addr,
    socklen_t addr_len) const;
----

== Return Value

0 on success, or ‐1 on error (with errno set).

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *addr*
| Address to bind the socket to.
| *addr_len*
| Size in bytes of the address pointed to by `addr`.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#