NetPeer Class |
Represents a local peer capable of holding zero, one or more connections to remote peers
Inheritance HierarchySystemObject
Internal.Lidgren.NetworkNetPeer
Internal.Lidgren.NetworkNetClient
Internal.Lidgren.NetworkNetServer
Internal.Lidgren.NetworkNetPeer
Internal.Lidgren.NetworkNetClient
Internal.Lidgren.NetworkNetServer
Namespace: Internal.Lidgren.Network
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2024.1.1.0 (2024.1.1.0)
SyntaxC#
public class NetPeer
The NetPeer type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Configuration |
Gets the configuration used to instanciate this NetPeer
|
| Connections |
Gets a copy of the list of connections
|
| ConnectionsCount |
Gets the number of active connections
|
| MessageReceivedEvent |
Signalling event which can be waited on to determine when a message is queued for reading.
Note that there is no guarantee that after the event is signaled the blocked thread will
find the message in the queue. Other user created threads could be preempted and dequeue
the message before the waiting thread wakes up.
|
| Port |
Gets the port number this NetPeer is listening and sending on, if Start() has been called
|
| Socket |
Gets the socket, if Start() has been called
|
| Statistics |
Statistics on this NetPeer since it was initialized
|
| Status |
Gets the NetPeerStatus of the NetPeer
|
| Tag |
Gets or sets the application defined object containing data about the peer
|
| UniqueIdentifier |
Gets a unique identifier for this NetPeer based on Mac address and ip/port. Note! Not available until Start() has been called!
|
| UPnP |
Returns an UPnP object if enabled in the NetPeerConfiguration
|
Methods| Name | Description | |
|---|---|---|
 | Connect(IPEndPoint) |
Create a connection to a remote endpoint
|
| Connect(IPEndPoint, NetOutgoingMessage) |
Create a connection to a remote endpoint
|
| Connect(String, Int32) |
Create a connection to a remote endpoint
|
| Connect(String, Int32, NetOutgoingMessage) |
Create a connection to a remote endpoint
|
| CreateMessage |
Creates a new message for sending
|
| CreateMessage(Int32) |
Creates a new message for sending
|
| CreateMessage(String) |
Creates a new message for sending and writes the provided string to it
|
| DiscoverKnownPeer(IPEndPoint) |
Emit a discovery signal to a single known host
|
| DiscoverKnownPeer(String, Int32) |
Emit a discovery signal to a single known host
|
| DiscoverLocalPeers |
Emit a discovery signal to all hosts on your subnet
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FlushSendQueue |
If NetPeerConfiguration.AutoFlushSendQueue() is false; you need to call this to send all messages queued using SendMessage()
|
| GetConnection |
Get the connection, if any, for a certain remote endpoint
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Introduce |
Send NetIntroduction to hostExternal and clientExternal; introducing client to host
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RawSend |
Send raw bytes; only used for debugging
|
| ReadMessage |
Read a pending message from any connection, if any
|
| ReadMessage(NetIncomingMessage) |
Reads a pending message from any connection, if any.
Returns true if message was read, otherwise false.
|
| ReadMessages |
Read a pending message from any connection, if any
|
| Recycle(NetIncomingMessage) |
Recycles a NetIncomingMessage instance for reuse; taking pressure off the garbage collector
|
| Recycle(IEnumerableNetIncomingMessage) |
Recycles a list of NetIncomingMessage instances for reuse; taking pressure off the garbage collector
|
| RegisterReceivedCallback |
Call this to register a callback for when a new message arrives
|
| SendDiscoveryResponse |
Send a discovery response message
|
| SendMessage(NetOutgoingMessage, NetConnection, NetDeliveryMethod) |
Send a message to a specific connection
|
| SendMessage(NetOutgoingMessage, NetConnection, NetDeliveryMethod, Int32) |
Send a message to a specific connection
|
| SendMessage(NetOutgoingMessage, IListNetConnection, NetDeliveryMethod, Int32) |
Send a message to a list of connections
|
| SendUnconnectedMessage(NetOutgoingMessage, IListIPEndPoint) |
Send a message to an unconnected host
|
| SendUnconnectedMessage(NetOutgoingMessage, IPEndPoint) |
Send a message to an unconnected host
|
| SendUnconnectedMessage(NetOutgoingMessage, String, Int32) |
Send a message to an unconnected host
|
| SendUnconnectedToSelf |
Send a message to this exact same netpeer (loopback)
|
| Shutdown |
Disconnects all active connections and closes the socket
|
| Start |
Binds to socket and spawns the networking thread
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UnregisterReceivedCallback |
Call this to unregister a callback, but remember to do it in the same synchronization context!
|
| WaitMessage |
Read a pending message from any connection, blocking up to maxMillis if needed
|
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
| PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |
See Also