nim-libp2p/libp2p/transports/transport.nim

64 lines
1.9 KiB
Nim
Raw Normal View History

## Nim-LibP2P
2019-09-24 17:48:23 +00:00
## Copyright (c) 2019 Status Research & Development GmbH
## Licensed under either of
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
## at your option.
## This file may not be copied, modified, or distributed except according to
## those terms.
2020-05-08 16:08:38 +00:00
import sequtils, tables
2019-09-28 19:56:13 +00:00
import chronos, chronicles
import ../connection,
2019-09-23 22:35:23 +00:00
../multiaddress,
../multicodec,
../errors
type
ConnHandler* = proc (conn: Connection): Future[void] {.gcsafe.}
Transport* = ref object of RootObj
ma*: Multiaddress
handler*: ConnHandler
multicodec*: MultiCodec
2020-05-08 16:08:38 +00:00
method initTransport*(t: Transport) {.base, gcsafe, locks: "unknown".} =
## perform protocol initialization
discard
2019-08-30 15:28:07 +00:00
method close*(t: Transport) {.base, async, gcsafe.} =
2019-08-21 22:53:16 +00:00
## stop and cleanup the transport
## including all outstanding connections
discard
2019-08-26 15:37:15 +00:00
method listen*(t: Transport,
ma: MultiAddress,
2020-05-05 15:55:02 +00:00
handler: ConnHandler):
2019-09-12 00:15:04 +00:00
Future[Future[void]] {.base, async, gcsafe.} =
2019-08-21 22:53:16 +00:00
## listen for incoming connections
t.ma = ma
t.handler = handler
trace "starting node", address = $ma
2019-08-26 15:37:15 +00:00
method dial*(t: Transport,
2019-09-23 22:35:23 +00:00
address: MultiAddress):
2019-08-30 15:28:07 +00:00
Future[Connection] {.base, async, gcsafe.} =
## dial a peer
discard
2019-09-23 22:35:23 +00:00
method upgrade*(t: Transport) {.base, async, gcsafe.} =
2019-08-30 22:16:37 +00:00
## base upgrade method that the transport uses to perform
## transport specific upgrades
discard
2019-08-30 15:28:07 +00:00
method handles*(t: Transport, address: MultiAddress): bool {.base, gcsafe.} =
## check if transport supportes the multiaddress
# by default we skip circuit addresses to avoid
# having to repeat the check in every transport
address.protocols.filterIt( it == multiCodec("p2p-circuit") ).len == 0
2019-09-12 17:07:34 +00:00
method localAddress*(t: Transport): MultiAddress {.base, gcsafe.} =
## get the local address of the transport in case started with 0.0.0.0:0
discard