diff options
author | Andreas Rumpf <rumpf_a@web.de> | 2018-10-25 07:42:45 +0200 |
---|---|---|
committer | Andreas Rumpf <rumpf_a@web.de> | 2018-10-25 07:42:45 +0200 |
commit | 223e92b83a42b3963b74a49bae6d571f00bf32f8 (patch) | |
tree | b0413ed44642ed6a60900e7e13bd272e2e4a0987 /lib/deprecated | |
parent | f5a2c6e19d8c789ad1211264bac89bce7e569e54 (diff) | |
download | Nim-223e92b83a42b3963b74a49bae6d571f00bf32f8.tar.gz |
stdlib: documenation updates, the exception names have been changed
Diffstat (limited to 'lib/deprecated')
-rw-r--r-- | lib/deprecated/pure/asyncio.nim | 6 | ||||
-rw-r--r-- | lib/deprecated/pure/sockets.nim | 32 |
2 files changed, 19 insertions, 19 deletions
diff --git a/lib/deprecated/pure/asyncio.nim b/lib/deprecated/pure/asyncio.nim index 161941e53..39d77230a 100644 --- a/lib/deprecated/pure/asyncio.nim +++ b/lib/deprecated/pure/asyncio.nim @@ -180,7 +180,7 @@ proc asyncSocket*(domain: Domain = AF_INET, typ: SockType = SOCK_STREAM, protocol: Protocol = IPPROTO_TCP, buffered = true): AsyncSocket = ## Initialises an AsyncSocket object. If a socket cannot be initialised - ## EOS is raised. + ## OSError is raised. result = newAsyncSocket() result.socket = socket(domain, typ, protocol, buffered) result.proto = protocol @@ -476,7 +476,7 @@ proc recvLine*(s: AsyncSocket, line: var TaintedString): bool {.deprecated.} = ## if this function can only retrieve some data; it will save this data and ## add it to the result when a full line is retrieved. ## - ## Unlike ``sockets.recvLine`` this function will raise an EOS or ESSL + ## Unlike ``sockets.recvLine`` this function will raise an OSError or SslError ## exception if an error occurs. ## ## **Deprecated since version 0.9.2**: This function has been deprecated in @@ -512,7 +512,7 @@ proc readLine*(s: AsyncSocket, line: var TaintedString): bool = ## retrieved or the socket has been disconnected in which case ``line`` will ## be set to "". ## - ## This function will raise an EOS exception when a socket error occurs. + ## This function will raise an OSError exception when a socket error occurs. setLen(line.string, 0) var dataReceived = "".TaintedString var ret = s.socket.readLineAsync(dataReceived) diff --git a/lib/deprecated/pure/sockets.nim b/lib/deprecated/pure/sockets.nim index ed15f67e2..34881607f 100644 --- a/lib/deprecated/pure/sockets.nim +++ b/lib/deprecated/pure/sockets.nim @@ -23,7 +23,7 @@ ## ## SSL is supported through the OpenSSL library. This support can be activated ## by compiling with the ``-d:ssl`` switch. When an SSL socket is used it will -## raise ESSL exceptions when SSL errors occur. +## raise SslError exceptions when SSL errors occur. ## ## Asynchronous sockets are supported, however a better alternative is to use ## the `asyncio <asyncio.html>`_ module. @@ -262,7 +262,7 @@ proc socket*(domain: Domain = AF_INET, typ: SockType = SOCK_STREAM, protocol: Protocol = IPPROTO_TCP, buffered = true): Socket = ## Creates a new socket; returns `InvalidSocket` if an error occurs. - # TODO: Perhaps this should just raise EOS when an error occurs. + # TODO: Perhaps this should just raise OSError when an error occurs. when defined(Windows): result = newTSocket(winlean.socket(cint(domain), cint(typ), cint(protocol)), buffered) else: @@ -422,7 +422,7 @@ proc parseIp4*(s: string): BiggestInt = ## ## This is equivalent to `inet_ntoa`:idx:. ## - ## Raises EInvalidValue in case of an error. + ## Raises ValueError in case of an error. var a, b, c, d: int var i = 0 var j = parseInt(s, a, i) @@ -543,7 +543,7 @@ proc acceptAddr*(server: Socket, client: var Socket, address: var string) {. ## If ``server`` is non-blocking then this function returns immediately, and ## if there are no connections queued the returned socket will be ## ``InvalidSocket``. - ## This function will raise EOS if an error occurs. + ## This function will raise OSError if an error occurs. ## ## The resulting client will inherit any properties of the server socket. For ## example: whether the socket is buffered or not. @@ -664,7 +664,7 @@ proc close*(socket: Socket) = discard winlean.closesocket(socket.fd) else: discard posix.close(socket.fd) - # TODO: These values should not be discarded. An EOS should be raised. + # TODO: These values should not be discarded. An OSError should be raised. # http://stackoverflow.com/questions/12463473/what-happens-if-you-call-close-on-a-bsd-socket-multiple-times when defined(ssl): if socket.isSSL: @@ -920,7 +920,7 @@ when defined(ssl): ## Returns ``False`` whenever the socket is not yet ready for a handshake, ## ``True`` whenever handshake completed successfully. ## - ## A ESSL error is raised on any other errors. + ## A SslError error is raised on any other errors. result = true if socket.isSSL: var ret = SSLConnect(socket.sslHandle) @@ -946,7 +946,7 @@ when defined(ssl): ## Determines whether a handshake has occurred between a client (``socket``) ## and the server that ``socket`` is connected to. ## - ## Throws ESSL if ``socket`` is not an SSL socket. + ## Throws SslError if ``socket`` is not an SSL socket. if socket.isSSL: return not socket.sslNoHandshake else: @@ -1215,7 +1215,7 @@ proc recv*(socket: Socket, data: var string, size: int, timeout = -1): int = ## ## When 0 is returned the socket's connection has been closed. ## - ## This function will throw an EOS exception when an error occurs. A value + ## This function will throw an OSError exception when an error occurs. A value ## lower than 0 is never returned. ## ## A timeout may be specified in milliseconds, if enough data is not received @@ -1273,7 +1273,7 @@ proc recvLine*(socket: Socket, line: var TaintedString, timeout = -1): bool {. ## will be set to it. ## ## ``True`` is returned if data is available. ``False`` suggests an - ## error, EOS exceptions are not raised and ``False`` is simply returned + ## error, OSError exceptions are not raised and ``False`` is simply returned ## instead. ## ## If the socket is disconnected, ``line`` will be set to ``""`` and ``True`` @@ -1321,7 +1321,7 @@ proc readLine*(socket: Socket, line: var TaintedString, timeout = -1) {. ## ## If the socket is disconnected, ``line`` will be set to ``""``. ## - ## An EOS exception will be raised in the case of a socket error. + ## An OSError exception will be raised in the case of a socket error. ## ## A timeout can be specified in milliseconds, if data is not received within ## the specified time an ETimeout exception will be raised. @@ -1394,7 +1394,7 @@ proc readLineAsync*(socket: Socket, ## * If some data has been retrieved; ``ReadPartialLine`` is returned. ## * If the socket has been disconnected; ``ReadDisconnected`` is returned. ## * If no data could be retrieved; ``ReadNone`` is returned. - ## * If call to ``recv`` failed; **an EOS exception is raised.** + ## * If call to ``recv`` failed; **an OSError exception is raised.** setLen(line.string, 0) template errorOrNone = @@ -1421,7 +1421,7 @@ proc readLineAsync*(socket: Socket, proc recv*(socket: Socket): TaintedString {.tags: [ReadIOEffect], deprecated.} = ## receives all the available data from the socket. - ## Socket errors will result in an ``EOS`` error. + ## Socket errors will result in an ``OSError`` error. ## If socket is not a connectionless socket and socket is not connected ## ``""`` will be returned. ## @@ -1470,7 +1470,7 @@ proc recvAsync*(socket: Socket, s: var TaintedString): bool {. tags: [ReadIOEffect], deprecated.} = ## receives all the data from a non-blocking socket. If socket is non-blocking ## and there are no messages available, `False` will be returned. - ## Other socket errors will result in an ``EOS`` error. + ## Other socket errors will result in an ``OSError`` error. ## If socket is not a connectionless socket and socket is not connected ## ``s`` will be set to ``""``. ## @@ -1547,7 +1547,7 @@ proc recvFromAsync*(socket: Socket, data: var string, length: int, address: var string, port: var Port, flags = 0'i32): bool {.tags: [ReadIOEffect].} = ## Variant of ``recvFrom`` for non-blocking sockets. Unlike ``recvFrom``, - ## this function will raise an EOS error whenever a socket error occurs. + ## this function will raise an OSError error whenever a socket error occurs. ## ## If there is no data to be read from the socket ``False`` will be returned. result = true @@ -1622,7 +1622,7 @@ proc sendAsync*(socket: Socket, data: string): int {.tags: [WriteIOEffect].} = ## returns the amount of bytes of ``data`` that was successfully sent. This ## number may not always be the length of ``data`` but typically is. ## - ## An EOS (or ESSL if socket is an SSL socket) exception is raised if an error + ## An OSError (or SslError if socket is an SSL socket) exception is raised if an error ## occurs. result = send(socket, cstring(data), data.len) when defined(ssl): @@ -1656,7 +1656,7 @@ proc sendAsync*(socket: Socket, data: string): int {.tags: [WriteIOEffect].} = proc trySend*(socket: Socket, data: string): bool {.tags: [WriteIOEffect].} = - ## safe alternative to ``send``. Does not raise an EOS when an error occurs, + ## safe alternative to ``send``. Does not raise an OSError when an error occurs, ## and instead returns ``false`` on failure. result = send(socket, cstring(data), data.len) == data.len |