| TcpExtOutgoingConnection Method (EndPoint, EndPoint, IImmutableList`1InetSocketOption, Boolean, NullableTimeSpan, NullableTimeSpan) |
Creates a
TcpOutgoingConnection instance representing a prospective TCP client connection to the given endpoint.
Namespace:
Akka.Streams.Dsl
Assembly:
Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax public Flow<ByteString, ByteString, Task<TcpOutgoingConnection>> OutgoingConnection(
EndPoint remoteAddress,
EndPoint localAddress = null,
IImmutableList<InetSocketOption> options = null,
bool halfClose = true,
Nullable<TimeSpan> connectionTimeout = null,
Nullable<TimeSpan> idleTimeout = null
)
member OutgoingConnection :
remoteAddress : EndPoint *
?localAddress : EndPoint *
?options : IImmutableList<InetSocketOption> *
?halfClose : bool *
?connectionTimeout : Nullable<TimeSpan> *
?idleTimeout : Nullable<TimeSpan>
(* Defaults:
let _localAddress = defaultArg localAddress null
let _options = defaultArg options null
let _halfClose = defaultArg halfClose true
let _connectionTimeout = defaultArg connectionTimeout null
let _idleTimeout = defaultArg idleTimeout null
*)
-> Flow<ByteString, ByteString, Task<TcpOutgoingConnection>>
Parameters
- remoteAddress
- Type: System.NetEndPoint
The remote address to connect to - localAddress (Optional)
- Type: System.NetEndPoint
Optional local address for the connection - options (Optional)
- Type: IImmutableListInetSocketOption
TCP options for the connections, see Tcp for details - halfClose (Optional)
- Type: SystemBoolean
Controls whether the connection is kept open even after writing has been completed to the accepted TCP connections.
If set to true, the connection will implement the TCP half-close mechanism, allowing the server to
write to the connection even after the client has finished writing.The TCP socket is only closed
after both the client and server finished writing. This setting is recommended for clients and therefore it is the default setting.
If set to false, the connection will immediately closed once the client closes its write side,
independently whether the server is still attempting to write.
- connectionTimeout (Optional)
- Type: SystemNullableTimeSpan
TBD - idleTimeout (Optional)
- Type: SystemNullableTimeSpan
TBD
Return Value
Type:
FlowByteString,
ByteString,
TaskTcpOutgoingConnectionTBD
See Also