ObjFW  Check-in [2d409b0c35]

Overview
Comment:OFIPXSocket: Minor documentation fix
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 2d409b0c35895226245a5bfed7f6722756b72d3f70a482f5595ae3f935c7d4ee
User & Date: js on 2020-05-28 23:22:05
Other Links: manifest | tags
Context
2020-05-28
23:59
tests: Add the same libctru id workaround check-in: d0ad47358c user: js tags: trunk
23:31
Merge trunk into 1.0 branch check-in: 370ec3dc84 user: js tags: 1.0
23:22
OFIPXSocket: Minor documentation fix check-in: 2d409b0c35 user: js tags: trunk
23:10
Use Fossil for "make tarball" check-in: 87b501fa1c user: js tags: trunk
Changes

Modified src/OFIPXSocket.h from [28e1d8cb6f] to [5fdb0d34da].

32
33
34
35
36
37
38

39

40
41
42
43
44
45
46
47
/*!
 * @class OFIPXSocket OFIPXSocket.h ObjFW/OFIPXSocket.h
 *
 * @brief A class which provides methods to create and use IPX sockets.
 *
 * Addresses are of type @ref of_socket_address_t. You can use
 * @ref of_socket_address_ipx to create an address or

 * @ref of_socket_address_ipx_get to get the IPX network, node and port

 * (somtimes also called socket number).
 *
 * @warning Even though the OFCopying protocol is implemented, it does *not*
 *	    return an independent copy of the socket, but instead retains it.
 *	    This is so that the socket can be used as a key for a dictionary,
 *	    so context can be associated with a socket. Using a socket in more
 *	    than one thread at the same time is not thread-safe, even if copy
 *	    was called to create one "instance" for every thread!







>
|
>
|







32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/*!
 * @class OFIPXSocket OFIPXSocket.h ObjFW/OFIPXSocket.h
 *
 * @brief A class which provides methods to create and use IPX sockets.
 *
 * Addresses are of type @ref of_socket_address_t. You can use
 * @ref of_socket_address_ipx to create an address or
 * @ref of_socket_address_get_ipx_network to get the IPX network,
 * @ref of_socket_address_get_ipx_node to get the IPX node and
 * @ref of_socket_address_get_port to get the port (sometimes also called
 * socket number).
 *
 * @warning Even though the OFCopying protocol is implemented, it does *not*
 *	    return an independent copy of the socket, but instead retains it.
 *	    This is so that the socket can be used as a key for a dictionary,
 *	    so context can be associated with a socket. Using a socket in more
 *	    than one thread at the same time is not thread-safe, even if copy
 *	    was called to create one "instance" for every thread!