mirror of https://github.com/apple/swift-nio.git synced 2026-05-20 20:30:36 +00:00

Files

T

History

Rafael Cepeda b60d141920 Document when channel.remoteAddress field can be nil (#3456 )

Added extra documentation to `channel.remoteAddress` field to capture a
scenario where this field might be `nil`

### Motivation:

It is somewhat common for users to have code like
`channel.remoteAddress!` in their implementation, as it is a reasonable
assumption to think a socket connection will have an associated remote
address. However, in at least one known situation this might not be the
case. When that happens, user's code might crash due to the force unwrap
of the optional field.

### Modifications:

Introduced more documentation to make it clear that users should be
prepared to handle the `nil` scenario.

### Result:

Less frequent mishandling of `channel.remoteAddress`.

2025-12-01 11:09:56 +00:00

main.swift

Document when channel.remoteAddress field can be nil (#3456 )

2025-12-01 11:09:56 +00:00

README.md

Add READMEs for the various sample applications (#117 )

2018-03-09 09:06:06 -08:00

README.md

NIOChatClient

This sample application provides a client for the NIOChatServer. Invoke it using one of the following syntaxes:

swift run NIOChatClient  # Connects to a server on ::1, port 9999.
swift run NIOChatClient 9899  # Connects to a server on ::1, port 9899
swift run NIOChatClient /path/to/unix/socket  # Connects to a server using the given UNIX socket
swift run NIOChatClient chat.example.com 9899  # Connects to a server on chat.example.com:9899