diff --git a/GBase.Api/Communication/ICommunicationSettings.cs b/GBase.Api/Communication/ICommunicationSettings.cs
index 78db4d8..a74caaf 100644
--- a/GBase.Api/Communication/ICommunicationSettings.cs
+++ b/GBase.Api/Communication/ICommunicationSettings.cs
@@ -6,13 +6,39 @@ using System.Net;
namespace GBase.Api.Communication
{
+ ///
+ /// Settings for a client-server communication
+ ///
public interface ICommunicationSettings
{
+ ///
+ /// The used
+ ///
ServerProtocol Protocol { get; }
+
+ ///
+ /// The used
+ ///
IPAddress IpAddress { get; }
+
+ ///
+ /// The used port
+ ///
int Port { get; }
+
+ ///
+ /// The used endpoint for the GBase
+ ///
string GBaseEndpoint { get; }
+
+ ///
+ /// The used endpoint for the GBaseTable
+ ///
string GBaseTableEndpoint { get; }
+
+ ///
+ /// The used endpoint for the GBaseEntry
+ ///
string GBaseEntryEndpoint { get; }
}
}
\ No newline at end of file
diff --git a/GBase.Api/Communication/ServerProtocol.cs b/GBase.Api/Communication/ServerProtocol.cs
index ff4d7ca..24bd7c4 100644
--- a/GBase.Api/Communication/ServerProtocol.cs
+++ b/GBase.Api/Communication/ServerProtocol.cs
@@ -6,15 +6,38 @@ using System;
namespace GBase.Api.Communication
{
+ ///
+ /// The protocol used for the connection between client and server
+ ///
public enum ServerProtocol //TODO: Decide which protocols should be usable
{
+ ///
+ /// Http connection
+ ///
Http,
+
+ ///
+ /// Https connection
+ ///
Https,
+
+ ///
+ /// net.tcp connection
+ ///
Tcp
}
+ ///
+ /// Extension methods for the enum
+ ///
public static class ServerProtocolExtensions
{
+ ///
+ /// Get a protocol string for a
+ ///
+ /// The
+ /// A protocol string for the
+ /// Invalid protocol passed.
public static string GetProtocolString(this ServerProtocol protocol)
{
switch (protocol)
@@ -30,6 +53,12 @@ namespace GBase.Api.Communication
}
}
+ ///
+ /// Get the for a given
+ ///
+ /// The given
+ /// The for the given
+ /// Invalid string passed.
public static ServerProtocol GetServerProtocolFromString(string @string)
{
if (@string.Equals(@"http://") || @string.Equals("http"))
diff --git a/GBase.Api/GBase.Api.csproj b/GBase.Api/GBase.Api.csproj
index d5f4330..57d30f1 100644
--- a/GBase.Api/GBase.Api.csproj
+++ b/GBase.Api/GBase.Api.csproj
@@ -4,6 +4,10 @@
netstandard2.1
+
+ D:\workspace\Testprojekte\GBase\GBase.Api\GBase.Api.xml
+
+
diff --git a/GBase.Api/GBase.Api.xml b/GBase.Api/GBase.Api.xml
new file mode 100644
index 0000000..aa58443
--- /dev/null
+++ b/GBase.Api/GBase.Api.xml
@@ -0,0 +1,128 @@
+
+
+
+ GBase.Api
+
+
+
+
+ Settings for a client-server communication
+
+
+
+
+ The used
+
+
+
+
+ The used
+
+
+
+
+ The used port
+
+
+
+
+ The used endpoint for the GBase
+
+
+
+
+ The used endpoint for the GBaseTable
+
+
+
+
+ The used endpoint for the GBaseEntry
+
+
+
+
+ The protocol used for the connection between client and server
+
+
+
+
+ Http connection
+
+
+
+
+ Https connection
+
+
+
+
+ net.tcp connection
+
+
+
+
+ Extension methods for the enum
+
+
+
+
+ Get a protocol string for a
+
+ The
+ A protocol string for the
+ Invalid protocol passed.
+
+
+
+ Get the for a given
+
+ The given
+ The for the given
+ Invalid string passed.
+
+
+
+ ServiceContract for the GBaseEntry
+
+
+
+
+ Dummy OperationContract
+
+
+
+
+ ServiceContract for the GBase
+
+
+
+
+ Add a table to the GBase
+
+ True if successful, false if not
+
+
+
+ Remove a table from the GBase
+
+ True if successful, false if not
+
+
+
+ ServiceContract for the GBaseTable
+
+
+
+
+ Add an entry to the GBaseTable
+
+ True if successful, false if not
+
+
+
+ Remove an entry from the GBaseTable
+
+ True if successful, false if not
+
+
+
diff --git a/GBase.Api/Services/IGBaseEntryService.cs b/GBase.Api/Services/IGBaseEntryService.cs
index edf87fc..ce98c98 100644
--- a/GBase.Api/Services/IGBaseEntryService.cs
+++ b/GBase.Api/Services/IGBaseEntryService.cs
@@ -7,9 +7,15 @@ using System.ServiceModel;
namespace GBase.Api.Services
{
+ ///
+ /// ServiceContract for the GBaseEntry
+ ///
[ServiceContract]
public interface IGBaseEntryService : IAsyncDisposable //TODO: Add OperationContracts for all operations this service has to do
{
+ ///
+ /// Dummy OperationContract
+ ///
[OperationContract]
void Dummy();
}
diff --git a/GBase.Api/Services/IGBaseService.cs b/GBase.Api/Services/IGBaseService.cs
index f87ecfd..68115c7 100644
--- a/GBase.Api/Services/IGBaseService.cs
+++ b/GBase.Api/Services/IGBaseService.cs
@@ -7,12 +7,23 @@ using System.ServiceModel;
namespace GBase.Api.Services
{
+ ///
+ /// ServiceContract for the GBase
+ ///
[ServiceContract]
public interface IGBaseService : IAsyncDisposable //TODO: Add OperationContracts for all operations this service has to do
{
+ ///
+ /// Add a table to the GBase
+ ///
+ /// True if successful, false if not
[OperationContract]
bool AddTable();
+ ///
+ /// Remove a table from the GBase
+ ///
+ /// True if successful, false if not
[OperationContract]
bool RemoveTable();
}
diff --git a/GBase.Api/Services/IGBaseTableService.cs b/GBase.Api/Services/IGBaseTableService.cs
index 982572c..82c6b74 100644
--- a/GBase.Api/Services/IGBaseTableService.cs
+++ b/GBase.Api/Services/IGBaseTableService.cs
@@ -7,10 +7,24 @@ using System.ServiceModel;
namespace GBase.Api.Services
{
+ ///
+ /// ServiceContract for the GBaseTable
+ ///
[ServiceContract]
public interface IGBaseTableService : IAsyncDisposable //TODO: Add OperationContracts for all operations this service has to do
{
+ ///
+ /// Add an entry to the GBaseTable
+ ///
+ /// True if successful, false if not
[OperationContract]
- void Dummy();
+ bool AddEntry();
+
+ ///
+ /// Remove an entry from the GBaseTable
+ ///
+ /// True if successful, false if not
+ [OperationContract]
+ bool RemoveEntry();
}
}
\ No newline at end of file