Option Strict On
Option Explicit On
Option Infer Off
Namespace Networking.RattleSnake.EventArgs
'Connector
'''
''' Contains the arguments for when a RattleSnake Connector has connected successfully to a server.
'''
''' A similar class is used for when a RattleSnake Client has connected successfully to a server.
Public Class RattleSnakeConnectorConnectedEventArgs
Inherits System.EventArgs
'''
''' The resulting client that is created because of the newly established connection.
'''
''' RattleSnakeClient
''' The newly created client that holds a connection to the server.
''' The returned property always holds a client that has a connection to the server.
Public Property Client As RattleSnakeClient
'''
''' The remote IP address that the connection is located on.
'''
''' String
''' An IP address of the remote RattleSnake Server
'''
Public Property IP As String
'''
''' The remote port that the connection is located on.
'''
''' Integer
''' The port used while connecting to the server.
'''
Public Property Port As Integer
End Class
'''
''' Contains the data to pass during an async connection routine.
'''
'''
Public Class RattleSnakeConnectorAsyncData
'''
''' The TcpClient that is performing the connection
'''
''' TcpClient
''' The TcpClient that now contains an active connection to the RattleSnake Server
'''
Public Property Client As Net.Sockets.TcpClient
'''
''' The remote IP address that the connection is located on.
'''
''' String
''' An IP address of the remote RattleSnake Server
'''
Public Property IP As String
'''
''' The remote port that the connection is located on.
'''
''' Integer
''' The port used while connecting to the server.
'''
Public Property Port As Integer
End Class
'Client
'''
''' Contains the necessary information for when a connection times out either when sending, receiving, or connecting.
'''
''' These event arguments contain all the information for when a connection times out, such as if it was sending, receiving, or connecting and the server IP.
Public Class RattleSnakeConnectionTimedOutEventArgs
'''
''' The enumeration that provides quick access to the different types of timeouts that can occur.
'''
''' This enum is simply a list of Integers for remembering the different types.
Public Enum TType
'''
''' The connection timed out while sending data across the stream.
'''
'''
Sending
'''
''' The connection timed out while receiving data from the stream.
'''
'''
Receiving
'''
''' The connection timed out while trying to connect to the server.
'''
'''
Connecting
End Enum
'''
''' The server IP address that the timeout occurred on.
'''
''' String
''' The server that the RattleSnake Client or Connector is trying to work with.
''' Just a plain-text string, IPv4
Public Property IP As String
'''
''' The remote port that the connection is located on.
'''
''' Integer
''' The port used while connecting to the server.
'''
Public Property Port As Integer
'''
''' Retrieves or sets the time of timeout that occurred.
'''
''' TType
''' A plain-text answer that spells out the type of timeout that occurred.
'''
Public Property TimeoutType As TType
'''
''' The specific exception data that travels up with the event arguments
'''
''' Exception
''' Specific exception data that is used during debugging
'''
Public Property Exception As Exception
End Class
'''
''' Contains the data to pass up whenever data is received.
'''
'''
Public Class RattleSnakeClientIncomingDataEventArgs
Inherits System.EventArgs
'''
''' The initial byte array that contains the raw data.
'''
''' Byte()
''' A byte array that is the raw data from the RattleSnake Server.
'''
Public Property Data As Byte()
'''
''' An object that represents a de-serialized version of the Data array.
'''
''' Object
''' This property could return any variety of objects if the byte array does in fact contain data that can be de-serialized.
''' This will only return an object if and only if the data array can in fact be deserialized.
Public ReadOnly Property Obj As Object
Get
'Create the memory stream
Dim _ms As New IO.MemoryStream(Data)
'Create the deserializer
Dim _deserializer As New System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
'Try
'Try deserializing
Dim _obj As Object = _deserializer.Deserialize(_ms)
'Close the memory stream
_ms.Close()
'Return the object
Return _obj
'Catch ex As System.Runtime.Serialization.SerializationException
' 'The data cannot be deserialized, return nothing
' Return Nothing
'End Try
End Get
End Property
'''
''' The originating client that received the data.
'''
''' RattleSnakeClient
''' The Client that has received the information.
'''
Public Property Client As RattleSnakeClient
End Class
'''
''' Contains the data of the connection that terminated.
'''
'''
Public Class RattleSnakeClientDisconnectionEventArgs
Inherits System.EventArgs
'''
''' The server IP address that the connection was established on.
'''
''' String
''' The server that the RattleSnake Client disconnected from.
''' Just a plain-text string, IPv4
Public Property IP As String
'''
''' The remote port that the connection is located on.
'''
''' Integer
''' The port used while connecting to the server.
'''
Public Property Port As Integer
'''
''' The originating client that received the data.
'''
''' RattleSnakeClient
''' The Client that has received the information.
'''
Public Property Client As RattleSnakeClient
End Class
'''
''' Contains the exception data that caused the client to crash.
'''
'''
Public Class RattleSnakeClientExceptionEventArgs
Inherits System.EventArgs
'''
''' The originating client that the exception came from.
'''
''' RattleSnakeClient
''' The client that the exception spawned from.
'''
Public Property Client As RattleSnakeClient
'''
''' The root exception that crashed out the client.
'''
''' Exception
''' Exception details about the crash.
'''
Public Property Data As Exception
End Class
'Server
'''
''' Contains the data that is passed when a RattleSnakeClient connects to the RattleSnakeServer.
'''
'''
Public Class RattleSnakeServerIncomingConnectionEventArgs
Inherits System.EventArgs
'''
''' The client that has connected to the RattleSnakeServer.
'''
''' RattleSnakeClient
''' The client that has connected to the server.
'''
Public Property Client As RattleSnakeClient
End Class
'''
''' Contains the data that a server will pass up whenever a client receives incoming data.
'''
'''
Public Class RattleSnakeServerIncomingDataEventArgs
Inherits System.EventArgs
'''
''' The source client that has received the data.
'''
''' RattleSnakeClient
''' The RattleSnakeClient that has received the data.
'''
Public Property Client As RattleSnakeClient
'''
''' The actual data that the client has received.
'''
''' RattleSnakeClientIncomingDataEventArgs
''' The combined class that contains the physical data that the client has received.
'''
Public Property Data As RattleSnakeClientIncomingDataEventArgs
End Class
'''
''' Contains the information from the client that has disconnected.
'''
'''
Public Class RattleSnakeServerClientDisconnectionEventArgs
Inherits System.EventArgs
'''
''' The originating client that has disconnected from the system.
'''
''' RattleSnakeClient
''' The RattleSnakeClient that has disconnected.
'''
Public Property Client As RattleSnakeClient
End Class
'''
''' Contains the information from a client throwing an exception and crashing out.
'''
'''
Public Class RattleSnakeServerClientExceptionEventArgs
'''
''' The originating client that has disconnected from the system.
'''
''' RattleSnakeClient
''' The RattleSnakeClient that has disconnected.
'''
Public Property Client As RattleSnakeClient
'''
''' The exception information which includes a reference to the client that has thrown an exception.
'''
''' RattleSnakeClientExceptionEventArgs
''' A class that contains the originating exception and the source client that crashed.
'''
Public Property Data As RattleSnakeClientExceptionEventArgs
End Class
End Namespace
Namespace Networking.RattleSnake.Exceptions
'''
''' The base exception for all RattleSnake Exceptions. All exceptions MUST INHERIT this class.
'''
'''
Public Class RattleSnakeException
Inherits Exception
'''
''' The InnerException that contains additional information about a crash.
'''
''' Exception
''' Additional exception details about a crash.
'''
Public Shadows Property InnerException As Exception
'''
''' A plain-text error message that assists in debugging the exception.
'''
''' String
''' A complete error message that provides an overview of the exception.
'''
Public Shadows Property Message As String
End Class
'''
''' An exception that is thrown whenever the RattleSnakeServer attempts to initialize itself but fails.
'''
'''
Public Class RattleSnakeInitializationException
Inherits RattleSnakeException
' '''
' ''' The InnerException that contains additional information about a crash.
' '''
' ''' Exception
' ''' Additional exception details about a crash.
' '''
'Public Shadows Property InnerException As Exception
' '''
' ''' A plain-text error message that assists in debugging the exception.
' '''
' ''' String
' ''' A complete error message that provides an overview of the exception.
' '''
'Public Shadows Property Message As String
End Class
End Namespace
Namespace Networking.RattleSnake.Structures
'''
''' This structure is used to signal a disconnect from the system.
'''
'''
Public Structure Disconnect
End Structure
'''
''' A serializable structure that is used to transmit data across the Internet using RattleSnake.
'''
'''
_
Public Structure Message
'''
''' The name of the person sending the message.
'''
''' String
''' The name of the sender.
'''
Public Property Name As String
'''
''' The physical message that Name has sent.
'''
''' String
''' The message that was sent.
'''
Public Property Message As String
End Structure
End Namespace
Namespace Networking.RattleSnake
'''
''' The RattleSnake server. The RS server manages all the connected RS clients and keeps track of the data transmitted between them.
'''
''' The server is fully multi-threaded and takes care of all the connection and disconnection routines.
Public Class RattleSnakeServer
'''
''' This routine is called whenever the system has an incoming connection.
'''
''' The Async result of the client.
'''
Protected Overridable Sub OnIncomingConnection(ByVal IR As IAsyncResult)
Try
'Make sure the listener is still something
If _listener IsNot Nothing Then
'End the connection
Dim _client As System.Net.Sockets.TcpClient = _listener.EndAcceptTcpClient(IR)
'Make sure the client is actually a client
If _client IsNot Nothing Then
'Create a new client
Dim _rsc As New RattleSnakeClient(_client, String.Empty, Me.Port)
'Lock
SyncLock _clients
'Add it to the system
_clients.Add(_rsc)
End SyncLock
'Raise the event
RaiseEvent ClientConnection(Me, New EventArgs.RattleSnakeServerIncomingConnectionEventArgs With {.Client = _rsc})
End If
'Begin listening again
_listener.BeginAcceptTcpClient(New AsyncCallback(AddressOf OnIncomingConnection), _listener)
End If
Catch ex As Exception
'Generic RattleSnake error
Throw New Exceptions.RattleSnakeException With {.InnerException = ex, .Message = ex.Message}
End Try
End Sub
'''
''' This routine is called whenever the system has an incoming message.
'''
''' The source client that has received the incoming message.
''' The event arguments that contain the received data.
'''
Protected Overridable Sub OnIncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientIncomingDataEventArgs)
'Create the new event argument structure
Dim _new As New EventArgs.RattleSnakeServerIncomingDataEventArgs With {.Data = e, .Client = CType(sender, RattleSnakeClient)}
'Raise the event
RaiseEvent IncomingData(Me, _new)
End Sub
'''
''' This routine is called whenever the system has a client disconnect.
'''
''' The client that has disconnected.
'''
Protected Overridable Sub OnClientDisconnection(ByVal sender As Object)
'Raise an event
RaiseEvent ClientDisconnection(Me, New EventArgs.RattleSnakeServerClientDisconnectionEventArgs With {.Client = CType(sender, RattleSnakeClient)})
End Sub
'''
''' This routine is called whenever the system has a client that throws an exception.
'''
''' The client that has thrown the exception.
''' The originating exception data that traveled up with the client.
'''
Protected Overridable Sub OnClientException(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'Raise the new event
RaiseEvent ClientException(Me, New EventArgs.RattleSnakeServerClientExceptionEventArgs With {.Client = CType(sender, RattleSnakeClient), .Data = e})
End Sub
'''
''' The port that the server will utilize.
'''
'''
Private _sP As Integer
'''
''' The TcpListener that will monitor for incoming connections.
'''
''' The listener will keep an eye out for any incoming connections to port 6110.
Private _listener As Net.Sockets.TcpListener
'''
''' A complete list of all connected RattleSnake Clients.
'''
''' The list should be kept in-sync with what is actually connected to the server.
Private _clients As List(Of RattleSnakeClient)
'''
''' This event is raised whenever the system has a client that receives incoming data.
'''
''' The originating server that processed the incoming data request.
''' The physical incoming data, including a reference to the client that accepted the data.
'''
Public Event IncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerIncomingDataEventArgs)
'''
''' This event is raised whenever the system has a client that has disconnected.
'''
''' The originating server that the client has disconnected from.
''' The disconnection information event arguments
'''
Public Event ClientDisconnection(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerClientDisconnectionEventArgs)
'''
''' This event is raised whenever the system has a client that throws an exception.
'''
''' The originating server that the client has thrown an exception on.
''' The exception data which includes a reference to the source client that has thrown the actual exception.
'''
Public Event ClientException(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerClientExceptionEventArgs)
'''
''' This event is raised whenever the system has a client connect successfully.
'''
''' The originating server that the client has connected on.
''' The event arguments that contain a reference to the client that has connected successfully.
'''
Public Event ClientConnection(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerIncomingConnectionEventArgs)
'''
''' Retrieves the IP addrss of this server.
'''
'''
'''
'''
Public Shared ReadOnly Property GetExternalIP As String
Get
Try
'Return a reader
Return New IO.StreamReader(System.Net.HttpWebRequest.Create("http://whatismyip.com/automation/n09230945.asp").GetResponse().GetResponseStream()).ReadToEnd
Catch ex As Exception
'An error :(
Return String.Empty
End Try
End Get
End Property
'''
''' Retrieves the port that the RattleSnakeServer will listen to for connections.
'''
''' Integer
''' The port that the underlying TcpListener is listening on
''' This is a Read-Only field
Public ReadOnly Property Port As Integer
Get
'Return the port that was used during initialization
Return _sP
End Get
End Property
'''
''' Retrieves the list of currently connected clients
'''
''' List of RattleSnakeClients
''' The list of connected clients
'''
Public ReadOnly Property Clients As List(Of RattleSnakeClient)
Get
Return _clients
End Get
End Property
'''
''' Initializes the RattleSnake Server
'''
''' The RattleSnake Server is initialized using the default properties with the port being 6110 and will listen on all IP-Address ranges that it has access to.
Public Sub New()
'Initialize
Me.New(6110I)
End Sub
'''
''' Initializes the RattleSnake Server
'''
''' The port that the server will listen for incoming connections on.
''' The RattleSnake Server is initialized using the specified port and will listen on all IP-Address ranges that it has access to.
Public Sub New(ByVal _port As Integer)
'Assign the variable
_sP = _port
'Initialize the listener
_listener = New Net.Sockets.TcpListener(System.Net.IPAddress.Any, _sP)
'Initailize the client list
_clients = New List(Of RattleSnakeClient)
End Sub
'''
''' Creates a new RattleSnakeServer that is ready to be started.
'''
''' RattleSnakeServer
''' A simple function that makes the initialization process of a RattleSnakeServer simpler.
Public Shared Function CreateServer() As RattleSnakeServer
'Return a new RattleSnakeServer
Return RattleSnakeServer.CreateServer(6110)
End Function
'''
''' Creates a new RattleSnakeServer that is ready to be started.
'''
''' RattleSnakeServer
''' The port that the new server will listen on.
''' A simple function that makes the initialization process of a RattleSnakeServer simpler.
Public Shared Function CreateServer(ByVal _port As Integer) As RattleSnakeServer
'Return a new server
Return New RattleSnakeServer(_port)
End Function
'''
''' Activates the underlying TcpListener
'''
'''
Public Sub BeginListening()
Try
'Run the server
_listener.Start(500I)
'Now begin accepting incoming connections
_listener.BeginAcceptTcpClient(New AsyncCallback(AddressOf OnIncomingConnection), _listener)
Catch ex As Exception
'Trap and throw another exception
Throw New RattleSnake.Exceptions.RattleSnakeInitializationException With {.InnerException = ex, .Message = ex.Message}
End Try
End Sub
'''
''' De-activates the underlying TcpListener
'''
''' Terminates the listener
Public Sub EndListening()
'Disable the listener
_listener.Stop()
End Sub
'''
''' Activates or deactivates the handlers of a client
'''
''' If true, the handles are registered. If false, the handles are removed.
''' The RattleSnakeClient that will have its handles modified.
'''
Private Sub [Handles](ByVal reg As Boolean, ByRef _cli As RattleSnakeClient)
'Check
If reg Then
'Add
AddHandler _cli.Crash, AddressOf _Crash
AddHandler _cli.Disconnected, AddressOf _Disconnected
AddHandler _cli.IncomingData, AddressOf _IncomingData
Else
'Remove
RemoveHandler _cli.Crash, AddressOf _Crash
RemoveHandler _cli.Disconnected, AddressOf _Disconnected
RemoveHandler _cli.IncomingData, AddressOf _IncomingData
End If
End Sub
Private Sub _Crash(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'The client has crashed, remove its handlers
[Handles](False, e.Client)
'Raise the event
Me.OnClientException(sender, e)
'Now, remove it from the main list
SyncLock _clients
'Remove
_clients.Remove(e.Client)
End SyncLock
'All done
e.Client.Disconnect(RattleSnakeClient.DisconnectOptions.DoNotSend)
End Sub
Private Sub _Disconnected(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientDisconnectionEventArgs)
'The client has crashed, remove its handlers
[Handles](False, CType(sender, RattleSnakeClient))
'Raise the event
Me.OnClientDisconnection(sender)
'Now, remove it from the main list
SyncLock _clients
'Remove
_clients.Remove(CType(sender, RattleSnakeClient))
End SyncLock
End Sub
Private Sub _IncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientIncomingDataEventArgs)
'Raise the event
Me.OnIncomingData(sender, e)
End Sub
End Class
'''
''' A Peer to Peer version of the RattleSnakeServer. This will keep track of one RattleSnakeClient to allow single communication between two people.
'''
''' The server is fully multi-threaded and takes care of all the connection and disconnection routines.
Public Class RattleSnakeP2PServer
'''
''' The listener that is responsible for managing incoming connections.
'''
'''
Private _listener As Net.Sockets.TcpListener
'''
''' The connected RattleSnakeClient that the P2P Server is responsible for.
'''
'''
Private _client As RattleSnakeClient
'''
''' The port that the server will listen on.
'''
'''
Private _port As Integer
'''
''' Retrieves the port that the Peer to Peer server is listening on.
'''
''' Integer
''' An Integer that represents the port that the server is listening on.
'''
Public ReadOnly Property Port As Integer
Get
Return _port
End Get
End Property
'''
''' Retrieves the currently connected client.
'''
''' RattleSnakeClient
''' The client that has an active connection with the server.
'''
Public ReadOnly Property Client As RattleSnakeClient
Get
Return _client
End Get
End Property
'''
''' This routine is called whenever the system has an incoming connection.
'''
''' The Async result of the client.
'''
Protected Overridable Sub OnIncomingConnection(ByVal IR As IAsyncResult)
Try
'Make sure the listener is still something
If _listener IsNot Nothing Then
'End the connection
Dim _cli As System.Net.Sockets.TcpClient = _listener.EndAcceptTcpClient(IR)
'Make sure the client is actually a client
If _cli IsNot Nothing Then
'Create a new client
Dim _rsc As New RattleSnakeClient(_cli, String.Empty, Me.Port)
'Save it
_client = _rsc
'Add handlers
Me.Handlers(True, _rsc)
'Raise the event
RaiseEvent ClientConnection(Me, New EventArgs.RattleSnakeServerIncomingConnectionEventArgs With {.Client = _rsc})
End If
'Turn off the listener
Me.EndListening()
End If
Catch ex As Exception
'Generic RattleSnake error
Throw New Exceptions.RattleSnakeException With {.InnerException = ex, .Message = ex.Message}
End Try
End Sub
'''
''' This routine is called whenever the system has an incoming message.
'''
''' The source client that has received the incoming message.
''' The event arguments that contain the received data.
'''
Protected Overridable Sub OnIncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientIncomingDataEventArgs)
'Create the new event argument structure
Dim _new As New EventArgs.RattleSnakeServerIncomingDataEventArgs With {.Data = e, .Client = CType(sender, RattleSnakeClient)}
'Check
Try
'Check to see if this is a disconnection attempt
If _new.Data.Obj.GetType Is GetType(Structures.Disconnect) Then Me.Client.Disconnect(RattleSnakeClient.DisconnectOptions.DoNotSend) : Return
Catch ex As System.Runtime.Serialization.SerializationException
'Not a serializable message, oh well
End Try
'Raise the event
RaiseEvent IncomingData(Me, _new)
End Sub
'''
''' This routine is called whenever the system has a client disconnect.
'''
''' The client that has disconnected.
'''
Protected Overridable Sub OnClientDisconnection(ByVal sender As Object)
'Raise an event
RaiseEvent ClientDisconnection(Me, New EventArgs.RattleSnakeServerClientDisconnectionEventArgs With {.Client = CType(sender, RattleSnakeClient)})
End Sub
'''
''' This routine is called whenever the system has a client that throws an exception.
'''
''' The client that has thrown the exception.
''' The originating exception data that traveled up with the client.
'''
Protected Overridable Sub OnClientException(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'Raise the new event
RaiseEvent ClientException(Me, New EventArgs.RattleSnakeServerClientExceptionEventArgs With {.Client = CType(sender, RattleSnakeClient), .Data = e})
End Sub
'''
''' This event is raised whenever the system has a client that receives incoming data.
'''
''' The originating server that processed the incoming data request.
''' The physical incoming data, including a reference to the client that accepted the data.
'''
Public Event IncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerIncomingDataEventArgs)
'''
''' This event is raised whenever the system has a client that has disconnected.
'''
''' The originating server that the client has disconnected from.
''' The disconnection information event arguments
'''
Public Event ClientDisconnection(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerClientDisconnectionEventArgs)
'''
''' This event is raised whenever the system has a client that throws an exception.
'''
''' The originating server that the client has thrown an exception on.
''' The exception data which includes a reference to the source client that has thrown the actual exception.
'''
Public Event ClientException(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerClientExceptionEventArgs)
'''
''' This event is raised whenever the system has a client connect successfully.
'''
''' The originating server that the client has connected on.
''' The event arguments that contain a reference to the client that has connected successfully.
'''
Public Event ClientConnection(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeServerIncomingConnectionEventArgs)
'''
''' Initializes a new RattleSnakeP2PServer for single party communication.
'''
'''
Public Sub New()
'Create a server on the default port
Me.New(6110)
End Sub
'''
''' Initializes a new RattleSnakeP2PServer for single party communication.
'''
''' The port to initialize the server on.
'''
Public Sub New(ByVal _p As Integer)
'Setup the listener
_listener = New Net.Sockets.TcpListener(Net.IPAddress.Any, _p)
'Store
_port = _p
End Sub
'''
''' Creates a new RattleSnakeServer that is ready to be started.
'''
''' RattleSnakeServer
''' A simple function that makes the initialization process of a RattleSnakeServer simpler.
Public Shared Function CreateServer() As RattleSnakeP2PServer
'Return a new RattleSnakeServer
Return RattleSnakeP2PServer.CreateServer(6110)
End Function
'''
''' Creates a new RattleSnakeServer that is ready to be started.
'''
''' RattleSnakeServer
''' The port that the new server will listen on.
''' A simple function that makes the initialization process of a RattleSnakeServer simpler.
Public Shared Function CreateServer(ByVal _port As Integer) As RattleSnakeP2PServer
'Return a new server
Return New RattleSnakeP2PServer(_port)
End Function
'''
''' Turns the server on to listen for an incoming connection.
'''
'''
Public Sub BeginListening()
'Flip on the TcpListener
_listener.Start(500I)
'Start the async acceptance routine.
_listener.BeginAcceptTcpClient(New AsyncCallback(AddressOf OnIncomingConnection), _listener)
End Sub
'''
''' Turns off the server, rejecting any more incoming connections.
'''
'''
Public Sub EndListening()
'Stop!
_listener.Stop()
End Sub
'''
''' Activates or deactivates the handlers of a client
'''
''' If true, the handles are registered. If false, the handles are removed.
''' The RattleSnakeClient that will have its handles modified.
'''
Private Sub Handlers(ByVal reg As Boolean, ByRef _cli As RattleSnakeClient)
'Check
If reg Then
'Add
AddHandler _cli.Crash, AddressOf _Crash
AddHandler _cli.Disconnected, AddressOf _Disconnected
AddHandler _cli.IncomingData, AddressOf _IncomingData
Else
'Remove
RemoveHandler _cli.Crash, AddressOf _Crash
RemoveHandler _cli.Disconnected, AddressOf _Disconnected
RemoveHandler _cli.IncomingData, AddressOf _IncomingData
End If
End Sub
Private Sub _Crash(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'Undo the handlers
Me.Handlers(False, _client)
'Looks like we're all out of connections.
Me.OnClientException(Me, e)
End Sub
Private Sub _Disconnected(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientDisconnectionEventArgs)
'Undo the handlers
Me.Handlers(False, _client)
'Looks like we're all out of connections.
Me.OnClientDisconnection(_client)
End Sub
Private Sub _IncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientIncomingDataEventArgs)
'Raise some data
Me.OnIncomingData(_client, e)
End Sub
End Class
'''
''' The RattleSnake client. The client is responsible for transmitting and receiving data from a RattleSnake server.
'''
''' The client is fully multi-threaded and takes care of cleaning up on a disconnection.
Public Class RattleSnakeClient
'''
''' The disconnection enum options
'''
'''
Public Enum DisconnectOptions
'''
''' Sends a disconnection request on the stream.
'''
'''
Send
'''
''' Does not send a disconnection request on the stream.
'''
'''
DoNotSend
End Enum
'''
''' The client that holds the network stream
'''
'''
Private _connectedClient As Net.Sockets.TcpClient
'''
''' The server IP.
'''
'''
Private _serverIP As String = String.Empty
'''
''' The server Port.
'''
'''
Private _serverPort As Integer = 0I
'''
''' The IP address of this client.
'''
'''
Private _ip As String = String.Empty
'''
''' Retrieves the IP address of this connected client.
'''
''' String
''' A string that contains a valid IP address of the connected client.
'''
Public ReadOnly Property IP As String
Get
Try
'Check to see if we haven't already done this
If Not _ip.Equals(String.Empty) Then Return _ip
'We have not, so get the IPEndPoint
Dim ipend As Net.IPEndPoint = CType(Me.Client.Client.RemoteEndPoint, Net.IPEndPoint)
'Make sure it's not nothing and assign the IP
If Not ipend Is Nothing Then _ip = ipend.Address.ToString Else _ip = (String.Empty)
'Return the IP
Return _ip
Catch ex As System.ObjectDisposedException
Return String.Empty
Catch ex As Net.Sockets.SocketException
Return String.Empty
End Try
End Get
End Property
'''
''' The server IP address that this client is connected to.
'''
''' String
'''
'''
Public ReadOnly Property ServerIP As String
Get
Return _serverIP
End Get
End Property
'''
''' The server Port that this client is connected to.
'''
''' Integer
''' The remote port that the RattleSnake Client is connected to.
'''
Public ReadOnly Property ServerPort As Integer
Get
Return _serverPort
End Get
End Property
'''
''' The TcpClient that is connected to the remote server.
'''
''' TcpClient
''' Connected Client
'''
Public ReadOnly Property Client As Net.Sockets.TcpClient
Get
Return _connectedClient
End Get
End Property
'''
''' This event is raised whenever the system receives some incoming data from the connection stream.
'''
''' The source RattleSnake Client
''' An Event Arguments class that contains all the information from the data that was retrieved.
'''
Public Event IncomingData(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientIncomingDataEventArgs)
'''
''' This event is raised whenever the client disconnects from the remote server.
'''
''' The source RattleSnake Client
''' The event arguments that detail the connection that was just disconnected.
'''
Public Event Disconnected(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientDisconnectionEventArgs)
'''
''' This event is raised whenever the client experiences a crash it cannot recover from.
'''
''' The source RattleSnake Client
''' The Exception Arguments that contain the crash data.
'''
Public Event Crash(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'''
''' This routine is called whenever the TcpClient begins to receive some data across the stream.
'''
''' The Asynchronous result that contains the initial data received.
'''
Protected Overridable Sub OnIncomingData(ByVal IR As IAsyncResult)
Try
'End
Dim _length As Integer = _connectedClient.Client.EndReceive(IR)
'Check
If Not _length.Equals(0) Then
'Get the data
Dim _data As Byte() = CType(IR.AsyncState, Byte())
'Resize
Array.Resize(_data, _length)
'Check
If _length.Equals(256) Then
'We have MORE
Do While Not _length.Equals(0)
'Create a new buffer
Dim _buffer(Byte.MaxValue) As Byte
'Get more data
_length = _connectedClient.Client.Receive(_buffer)
'Now, time to merge data
Dim _list As New List(Of Byte)(_data)
'Resize the buffer array
Array.Resize(_buffer, _length)
'Add the new data
_list.AddRange(_buffer)
'Reassign it back
_data = _list.ToArray
Loop
End If
'Create event args
Dim _rscidea As New EventArgs.RattleSnakeClientIncomingDataEventArgs With {.Data = _data, .Client = Me}
'Check
If _rscidea.Obj.GetType Is GetType(Structures.Disconnect) Then
Me.Disconnect(DisconnectOptions.DoNotSend)
Else
'Raise the event
RaiseEvent IncomingData(Me, New EventArgs.RattleSnakeClientIncomingDataEventArgs With {.Data = _data, .Client = Me})
'Restart reading for next time
Me.BeginReceive()
End If
End If
Catch ex As ObjectDisposedException
Debug.WriteLine("OnIncomingData() ODE")
End Try
End Sub
'''
''' This routine is called whenever the TcpClient finishes disconnecting from the remote stream.
'''
''' The AsyncResult that contains some infromation about the disconnection.
'''
Protected Overridable Sub OnDisconnection(ByVal IR As IAsyncResult)
Try
'End the disconnection attempt
_connectedClient.Client.EndDisconnect(IR)
'All finished
_connectedClient.Client.Close()
'Create our event arguments
Dim _rscdea As New EventArgs.RattleSnakeClientDisconnectionEventArgs With {.IP = Me.ServerIP, .Port = Me.ServerPort, .Client = Me}
'Raise the event
RaiseEvent Disconnected(Me, _rscdea)
Catch ex As ObjectDisposedException
Debug.WriteLine("OnDisconnection() ODE")
End Try
End Sub
'''
''' This routine is called whenever the client finishes sending all the data across the stream.
'''
''' The AsyncResult that contains some information about the data that was sent.
'''
Protected Overridable Sub OnDataSent(ByVal IR As IAsyncResult)
Try
'End the send
Dim _length As Integer = _connectedClient.Client.EndSend(IR)
'Now get the data array we sent
Dim _data() As Byte = CType(IR.AsyncState, Byte())
'Wrap in a try catch to see if it is a serialized routine.
Try
'Create some new event arguments
Dim _rscdsea As New EventArgs.RattleSnakeClientIncomingDataEventArgs With {.Data = _data, .Client = Me}
'Test to see if it is a disconnection routine.
If _rscdsea.Obj.GetType Is GetType(Networking.RattleSnake.Structures.Disconnect) Then Me.Disconnect(DisconnectOptions.DoNotSend)
Catch ex As System.Runtime.Serialization.SerializationException
'The data is not a serialized structure, do nothing else.
End Try
Catch ex As Exception
'Raise
Me.OnCrash(New RattleSnake.Exceptions.RattleSnakeException With {.InnerException = ex, .Message = ex.Message})
'Leave
Return
End Try
End Sub
'''
''' This routine is called whenever the client experiences a crash.
'''
''' The exception that contains the details of the crash.
'''
Protected Overridable Sub OnCrash(ByVal e As Exception)
'Pass it up
RaiseEvent Crash(Me, New EventArgs.RattleSnakeClientExceptionEventArgs With {.Data = e, .Client = Me})
End Sub
'''
''' Creates a new RattleSnake Client that holds a connection to a RattleSnake Server.
'''
''' The event arguments that contain all the required information to startup the server.
''' This method uses the connector event arguments instead of spreading out the arguments across three variables.
Public Sub New(ByRef e As EventArgs.RattleSnakeConnectorConnectedEventArgs)
'Assign
Me.New(e.Client.Client, e.IP, e.Port)
End Sub
'''
''' Creates a new RattleSnake Client that holds a connection to a RattleSnake Server.
'''
''' The TcpClient that holds the connection.
''' The Server IP address that the client is connected to.
''' The Server port that the client is connected to.
''' This method uses three parameters instead of one.
Public Sub New(ByRef _cli As Net.Sockets.TcpClient, ByVal _sIp As String, ByVal _sPo As Integer)
'Assign
_connectedClient = _cli
_serverIP = _sIp
_serverPort = _sPo
'Try
If _serverIP.Equals(Me.IP) Then Debug.WriteLine("same")
'Begin listening
Me.BeginReceive()
End Sub
'''
''' Begins disconnecting from the remote server.
'''
''' This method will send a disconnection warning.
Public Sub Disconnect()
'We are sending a warning
Me.Disconnect(DisconnectOptions.Send)
End Sub
'''
''' Begins disconnecting from the remote server.
'''
''' The disconnection options to use.
'''
Public Sub Disconnect(ByVal send As DisconnectOptions)
'Determine
If send.Equals(DisconnectOptions.Send) Then
'Send the request
Me.BeginSend(New RattleSnake.Structures.Disconnect)
Else
Try
'Disconnect
_connectedClient.Client.BeginDisconnect(False, New AsyncCallback(AddressOf OnDisconnection), Nothing)
Catch ex As Exception
Debug.WriteLine("Disconnect() ODE")
End Try
End If
End Sub
'''
''' Sends a serialized structure across the network stream.
'''
''' The serializable structure to send.
''' This routine will take the serialized structure and convert it to a byte array that will actually be transmitted across the stream.
Public Sub BeginSend(ByVal _data As Object)
'Create the temporary memory stream
Dim _ms As New IO.MemoryStream
'Create the serializer
Dim _s As New System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
'Serialize
_s.Serialize(_ms, _data)
'Get the byte array
Dim _arr() As Byte = _ms.ToArray
'Close the stream
_ms.Close()
'Call our other send
Me.BeginSend(_arr)
End Sub
'''
''' Sends a byte array across the network stream.
'''
''' The byte array to send.
''' This routine directly sends the bytes across the stream.
Public Sub BeginSend(ByVal _data() As Byte)
Try
'Send!
_connectedClient.Client.BeginSend(_data, 0, _data.Length, Net.Sockets.SocketFlags.None, New AsyncCallback(AddressOf OnDataSent), _data)
Catch ex As ObjectDisposedException
Debug.WriteLine("BeginSend() ODE.")
End Try
End Sub
'''
''' Begins receiving data across the stream.
'''
'''
Private Sub BeginReceive()
'The byte array will go from 0 To 255, which makes the byte array 256 in length
Dim _bytes(Byte.MaxValue) As Byte
'Start
_connectedClient.Client.BeginReceive(_bytes, 0, _bytes.Length, Net.Sockets.SocketFlags.None, New AsyncCallback(AddressOf OnIncomingData), _bytes)
End Sub
End Class
'''
''' A simplified class designed to easily create a connection between a client and server.
'''
''' The RS connector class is completely multi-threaded and returns a RS client that contains an active connection to a RS server.
Public Class RattleSnakeConnector
'''
''' This routine is raised whenever the client connects to a server.
'''
''' The result of the connection.
'''
Protected Shared Sub OnConnection(ByVal IR As IAsyncResult)
Try
'Get the leftover data
Dim _arguments As EventArgs.RattleSnakeConnectorAsyncData = CType(IR.AsyncState, EventArgs.RattleSnakeConnectorAsyncData)
'End the connection
_arguments.Client.EndConnect(IR)
'Create a new client
Dim _client As New RattleSnakeClient(_arguments.Client, _arguments.IP, _arguments.Port)
'Pass it all up
RaiseEvent ConnectionEstablished(Nothing, New EventArgs.RattleSnakeConnectorConnectedEventArgs With {.Client = _client, .IP = _client.ServerIP, .Port = _client.ServerPort})
Catch ex As Exception
'We crashed out
RaiseEvent ConnectionFailed(Nothing, New EventArgs.RattleSnakeClientExceptionEventArgs() With {.Client = Nothing, .Data = New RattleSnake.Exceptions.RattleSnakeException With {.InnerException = ex, .Message = ex.Message}})
End Try
End Sub
'''
''' This event is raised whenever the client has established a connection to a server.
'''
''' The Connector Class
''' The Event Arguments that contain the newly created client as a result of the connection.
'''
Public Shared Event ConnectionEstablished(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeConnectorConnectedEventArgs)
'''
''' This event is raised whenever the client has crashed in the connection attempt.
'''
''' The Connector Class
''' The event arguments containing the crash.
'''
Public Shared Event ConnectionFailed(ByVal sender As Object, ByVal e As EventArgs.RattleSnakeClientExceptionEventArgs)
'''
''' Launches a connection to a remote RattleSnake server.
'''
''' The RattleSnake Server IP address to connect to.
'''
Public Shared Sub Connect(ByVal _ip As String)
''Create a client
'Dim _client As New Net.Sockets.TcpClient()
''Start the connection
'_client.BeginConnect(_ip, 6110I, New AsyncCallback(AddressOf OnConnection), _client)
'Fire off a connection
RattleSnakeConnector.Connect(_ip, 6110)
End Sub
'''
''' Launches a connection to a remote RattleSnake server.
'''
''' The IP address to connect on.
''' The port to connect on.
'''
Public Shared Sub Connect(ByVal _ip As String, ByVal _port As Integer)
'Create a client
Dim _client As New Net.Sockets.TcpClient()
'Start the connection
_client.BeginConnect(_ip, _port, New AsyncCallback(AddressOf RattleSnakeConnector.OnConnection), New EventArgs.RattleSnakeConnectorAsyncData With {.Client = _client, .IP = _ip, .Port = _port})
End Sub
End Class
End Namespace