1 #Region "Microsoft.VisualBasic::61f744038f9a91c79bba8fcfd539bebe, Microsoft.VisualBasic.Core\ApplicationServices\Tools\Network\Protocol\Reflection\Protocol.vb"
2
3     ' Author:
4     
5     '       asuka (amethyst.asuka@gcmodeller.org)
6     '       xie (genetics@smrucc.org)
7     '       xieguigang (xie.guigang@live.com)
8     
9     ' Copyright (c) 2018 GPL3 Licensed
10     
11     
12     ' GNU GENERAL PUBLIC LICENSE (GPL3)
13     
14     
15     ' This program is free software: you can redistribute it and/or modify
16     ' it under the terms of the GNU General Public License as published by
17     ' the Free Software Foundation, either version 3 of the License, or
18     ' (at your option) any later version.
19     
20     ' This program is distributed in the hope that it will be useful,
21     ' but WITHOUT ANY WARRANTY; without even the implied warranty of
22     ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23     ' GNU General Public License for more details.
24     
25     ' You should have received a copy of the GNU General Public License
26     ' along with this program. If not, see <http://www.gnu.org/licenses/>.
27
28
29
30     ' /********************************************************************************/
31
32     ' Summaries:
33
34     '     Class Protocol
35     
36     '         Properties: DeclaringType, EntryPoint
37     
38     '         Constructor: (+2 OverloadsSub New
39     '         FunctionGetEntryPoint, GetProtocolCategory, ToString
40     
41     
42     ' /********************************************************************************/
43
44 #End Region
45
46 Namespace Net.Protocols.Reflection
47
48     ''' <summary>
49     ''' This attribute indicates the entry point of the protocol processor definition location and the details of the protocol processor. 
50     ''' </summary>
51     <AttributeUsage(AttributeTargets.Class Or AttributeTargets.Method, AllowMultiple:=True, Inherited:=True)>
52     Public Class Protocol : Inherits Attribute
53
54         ''' <summary>
55         ''' Entry point for the data protocols, this property usually correspondent to the request stream's 
56         ''' property: <see cref="RequestStream.Protocol"/> and <see cref="RequestStream.ProtocolCategory"/>
57         ''' </summary>
58         ''' <returns></returns>
59         Public ReadOnly Property EntryPoint As Long
60         ''' <summary>
61         ''' 这个属性对于方法而言为空,但是对于类型入口点而言则不为空
62         ''' </summary>
63         ''' <returns></returns>
64         Public ReadOnly Property DeclaringType As Type
65
66         ''' <summary>
67         ''' Generates the protocol method entrypoint.(应用于服务器上面的协议处理方法)
68         ''' </summary>
69         ''' <param name="EntryPoint"></param>
70         Sub New(EntryPoint As Long)
71             Me.EntryPoint = EntryPoint
72         End Sub
73
74         ''' <summary>
75         ''' Generates the <see cref="ProtocolHandler"/> on the server side, this is using for initialize a protocol API entry point.(客户端上面的类型)
76         ''' </summary>
77         ''' <param name="Type">客户端上面的类型</param>
78         Sub New(Type As Type)
79             EntryPoint = SecurityString.MD5Hash.ToLong(Type.GUID.ToByteArray)
80             DeclaringType = Type
81         End Sub
82
83         Public Overrides Function ToString() As String
84             If DeclaringType Is Nothing Then
85                 Return EntryPoint
86             Else
87                 Return $"*{EntryPoint}  ==> {DeclaringType.FullName}"
88             End If
89         End Function
90
91         ''' <summary>
92         ''' This method is usually using for generates a <see cref="protocolhandler"/> object.
93         ''' Correspondent to the protocol class property <see cref="RequestStream.ProtocolCategory"/>
94         ''' </summary>
95         ''' <param name="Type"></param>
96         ''' <returns></returns>
97         Public Shared Function GetProtocolCategory(Type As Type) As Protocol
98             Dim attrs As Object() = Type.GetCustomAttributes(attributeType:=GetType(Protocol), inherit:=True)
99             If attrs.IsNullOrEmpty Then
100                 Return Nothing
101             End If
102
103             Dim attr As Protocol = DirectCast(attrs(Scan0), Protocol)
104             Return attr
105         End Function
106
107         ''' <summary>
108         ''' This method is usually using for generates a details protocol processor, example is calling the method interface: <see cref="Net.Abstract.DataRequestHandler"/>
109         ''' Correspondent to the protocol entry property <see cref="RequestStream.Protocol"/>
110         ''' </summary>
111         ''' <param name="Method"></param>
112         ''' <returns></returns>
113         Public Shared Function GetEntryPoint(Method As System.Reflection.MethodInfo) As Protocol
114             Dim attrs As Object() = Method.GetCustomAttributes(attributeType:=GetType(Protocol), inherit:=True)
115             If attrs.IsNullOrEmpty Then
116                 Return Nothing
117             End If
118
119             Dim attr As Protocol = DirectCast(attrs(Scan0), Protocol)
120             Return attr
121         End Function
122     End Class
123 End Namespace