Giter Club home page Giter Club logo

enet's Introduction

enet

A complete re-implementation of the ENet protocol in Erlang/OTP.

API

The module enet presents the API of enet.

Data Types

port_number() = 0..65535

peer_count() = 1..255

channel_count() = 1..255

bytes_per_second() = non_neg_integer()

channels() = #{ non_neg_integer() := pid() }

Functions

start_host(Port, Options) -> {ok, pid()} | {error, atom()}

    Port = port_number()
    Options = [Option]
    Option =
      {peer_limit, peer_count()} |
      {channel_limit, channel_count()} |
      {incoming_bandwidth, bytes_per_second()} |
      {outgoing_bandwidth, bytes_per_second()}

Start a new host listening on Port.

stop_host(Port) -> ok

    Port = port_number()

Stop a host listening on Port.

connect_peer(Host, IP, Port, ChannelCount) -> {ok, Peer} | {error, atom()}

    Host = pid()
    IP = string()
    Port = port_number()
    ChannelCount = channel_count()

Start a new peer on Host connecting to a remote host on address IP:Port. If a successful connect handshake has been completed, the calling process will receive a message {enet, connect, local, {Host, Channels}, ConnectID}.

sync_connect_peer(Host, IP, Port, ChannelCount) -> {ok, {Peer, Channels}} | {error, atom()}

    Host = pid()
    IP = string()
    Port = port_number()
    ChannelCount = channel_count()
    Peer = pid()
    Channels = channels()

Equivalent to connect_peer/4 but synchronous. The function returns when the handshake is completed or after a timeout.

disconnect_peer(Peer) -> ok

    Peer = pid()

Disconnect Peer.

send_unsequenced(Channel, Data) -> ok

    Channel = pid()
    Data = iolist()

Send unsequenced data to the remote peer over Channel.

send_unreliable(Channel, Data) -> ok

    Channel = pid()
    Data = iolist()

Send unreliable data to the remote peer over Channel.

send_reliable(Channel, Data) -> ok

    Channel = pid()
    Data = iolist()

Send reliable data to the remote peer over Channel.

enet's People

Contributors

flambard avatar

Watchers

James Cloos avatar kebo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.