/// <summary>
/// Creates and initializes the LocalService part of the request.
/// </summary>
/// <returns>Request with initialized LocalService part.</returns>
public LocProtocolMessage CreateLocalServiceRequest()
{
LocProtocolMessage res = CreateRequest();
res.Request.LocalService = new LocalServiceRequest();
return(res);
}
/// <summary>
/// Creates a new response for a specific request with initialized LocalService part and STATUS_OK status code.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <returns>Response with initialized LocalService part.</returns>
public LocProtocolMessage CreateLocalServiceOkResponse(LocProtocolMessage Request)
{
LocProtocolMessage res = CreateOkResponse(Request);
res.Response.LocalService = new LocalServiceResponse();
return(res);
}
/// <summary>
/// Creates a response message to a NeighbourhoodChangedNotificationRequest message.
/// </summary>
/// <param name="Request">NeighbourhoodChangedNotificationRequest message for which the response is created.</param>
/// <returns>NeighbourhoodChangedNotificationResponse message that is ready to be sent.</returns>
public LocProtocolMessage CreateNeighbourhoodChangedNotificationResponse(LocProtocolMessage Request)
{
NeighbourhoodChangedNotificationResponse neighbourhoodChangedNotificationResponse = new NeighbourhoodChangedNotificationResponse();
LocProtocolMessage res = CreateLocalServiceOkResponse(Request);
res.Response.LocalService.NeighbourhoodUpdated = neighbourhoodChangedNotificationResponse;
return(res);
}
/// <summary>
/// Creates a new error response for a specific request with ERROR_INVALID_VALUE status code.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <param name="Details">Optionally, details about the error to be sent in 'Response.details'.</param>
/// <returns>Error response message that is ready to be sent.</returns>
public LocProtocolMessage CreateErrorInvalidValueResponse(LocProtocolMessage Request, string Details = null)
{
LocProtocolMessage res = CreateResponse(Request, Status.ErrorInvalidValue);
if (Details != null)
{
res.Response.Details = Details;
}
return(res);
}
/// <summary>
/// Creates a response message to a DeregisterServiceRequest message.
/// </summary>
/// <param name="Request">DeregisterServiceRequest message for which the response is created.</param>
/// <returns>DeregisterServiceResponse message that is ready to be sent.</returns>
public LocProtocolMessage CreateDeregisterServiceResponse(LocProtocolMessage Request)
{
DeregisterServiceResponse deregisterServiceResponse = new DeregisterServiceResponse();
LocProtocolMessage res = CreateLocalServiceOkResponse(Request);
res.Response.LocalService.DeregisterService = deregisterServiceResponse;
return(res);
}
/// <summary>
/// Creates a new NeighbourhoodChangedNotificationRequest message.
/// </summary>
/// <param name="Changes">List of changes in the neighborhood.</param>
/// <returns>NeighbourhoodChangedNotificationRequest message that is ready to be sent.</returns>
public LocProtocolMessage CreateNeighbourhoodChangedNotificationRequest(IEnumerable <NeighbourhoodChange> Changes)
{
NeighbourhoodChangedNotificationRequest neighbourhoodChangedNotificationRequest = new NeighbourhoodChangedNotificationRequest();
neighbourhoodChangedNotificationRequest.Changes.AddRange(Changes);
LocProtocolMessage res = CreateLocalServiceRequest();
res.Request.LocalService.NeighbourhoodChanged = neighbourhoodChangedNotificationRequest;
return(res);
}
/// <summary>
/// Creates a response message to a GetNeighbourNodesByDistanceLocalRequest message.
/// </summary>
/// <param name="Request">GetNeighbourNodesByDistanceLocalRequest message for which the response is created.</param>
/// <param name="Nodes">List of nodes in the neighborhood.</param>
/// <returns>GetNeighbourNodesByDistanceLocalResponse message that is ready to be sent.</returns>
public LocProtocolMessage CreateGetNeighbourNodesByDistanceLocalResponse(LocProtocolMessage Request, IEnumerable <NodeInfo> Nodes)
{
GetNeighbourNodesByDistanceResponse getNeighbourNodesByDistanceResponse = new GetNeighbourNodesByDistanceResponse();
getNeighbourNodesByDistanceResponse.Nodes.AddRange(Nodes);
LocProtocolMessage res = CreateLocalServiceOkResponse(Request);
res.Response.LocalService.GetNeighbourNodes = getNeighbourNodesByDistanceResponse;
return(res);
}
/// <summary>
/// Creates a new GetNeighbourNodesByDistanceLocalRequest message.
/// </summary>
/// <param name="KeepAlive">If set to true, the LOC server will send neighborhood updates over the open connection.</param>
/// <returns>GetNeighbourNodesByDistanceLocalRequest message that is ready to be sent.</returns>
public LocProtocolMessage CreateGetNeighbourNodesByDistanceLocalRequest(bool KeepAlive = true)
{
GetNeighbourNodesByDistanceLocalRequest getNeighbourNodesByDistanceLocalRequest = new GetNeighbourNodesByDistanceLocalRequest();
getNeighbourNodesByDistanceLocalRequest.KeepAliveAndSendUpdates = KeepAlive;
LocProtocolMessage res = CreateLocalServiceRequest();
res.Request.LocalService.GetNeighbourNodes = getNeighbourNodesByDistanceLocalRequest;
return(res);
}
/// <summary>
/// Creates a new DeregisterServiceRequest message.
/// </summary>
/// <param name="ServiceType">Type of service to unregister.</param>
/// <returns>DeregisterServiceRequest message that is ready to be sent.</returns>
public LocProtocolMessage CreateDeregisterServiceRequest(ServiceType ServiceType)
{
DeregisterServiceRequest deregisterServiceRequest = new DeregisterServiceRequest();
deregisterServiceRequest.ServiceType = ServiceType;
LocProtocolMessage res = CreateLocalServiceRequest();
res.Request.LocalService.DeregisterService = deregisterServiceRequest;
return(res);
}
/// <summary>
/// Creates a new RegisterServiceRequest message.
/// </summary>
/// <param name="ServiceInfo">Description of the service to register.</param>
/// <returns>RegisterServiceRequest message that is ready to be sent.</returns>
public LocProtocolMessage CreateRegisterServiceRequest(ServiceInfo ServiceInfo)
{
RegisterServiceRequest registerServiceRequest = new RegisterServiceRequest();
registerServiceRequest.Service = ServiceInfo;
LocProtocolMessage res = CreateLocalServiceRequest();
res.Request.LocalService.RegisterService = registerServiceRequest;
return(res);
}
/// <summary>
/// Creates a new response template for a specific request.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <param name="ResponseStatus">Status code of the response.</param>
/// <returns>Response message template for the request.</returns>
public LocProtocolMessage CreateResponse(LocProtocolMessage Request, Status ResponseStatus)
{
Message message = new Message();
message.Id = Request.Id;
message.Response = new Response();
message.Response.Status = ResponseStatus;
LocProtocolMessage res = new LocProtocolMessage(message);
return(res);
}
/// <summary>
/// Creates a new request template and sets its ID to ID of the last message + 1.
/// </summary>
/// <returns>New request message template.</returns>
public LocProtocolMessage CreateRequest()
{
int newId = Interlocked.Increment(ref id);
Message message = new Message();
message.Id = (uint)newId;
message.Request = new Request();
message.Request.Version = version;
LocProtocolMessage res = new LocProtocolMessage(message);
return(res);
}
/// <summary>
/// Creates a response message to a RegisterServiceRequest message.
/// </summary>
/// <param name="Request">RegisterServiceRequest message for which the response is created.</param>
/// <returns>RegisterServiceResponse message that is ready to be sent.</returns>
public LocProtocolMessage CreateRegisterServiceResponse(LocProtocolMessage Request, GpsLocation Location)
{
RegisterServiceResponse registerServiceResponse = new RegisterServiceResponse();
registerServiceResponse.Location = new Iop.Locnet.GpsLocation()
{
Latitude = Location.GetLocationTypeLatitude(),
Longitude = Location.GetLocationTypeLongitude()
};
LocProtocolMessage res = CreateLocalServiceOkResponse(Request);
res.Response.LocalService.RegisterService = registerServiceResponse;
return(res);
}
/// <summary>
/// Constructs ProtoBuf message from raw data read from the network stream.
/// </summary>
/// <param name="Data">Raw data to be decoded to the message.</param>
/// <returns>ProtoBuf message or null if the data do not represent a valid message.</returns>
public static IProtocolMessage CreateMessageFromRawData(byte[] Data)
{
log.Trace("()");
LocProtocolMessage res = null;
try
{
res = new LocProtocolMessage(MessageWithHeader.Parser.ParseFrom(Data).Body);
string msgStr = res.ToString();
log.Trace("Received message:\n{0}", msgStr.SubstrMax(512));
}
catch (Exception e)
{
log.Warn("Exception occurred, connection to the client will be closed: {0}", e.ToString());
// Connection will be closed in calling function.
}
log.Trace("(-):{0}", res != null ? "Message" : "null");
return(res);
}
/// <summary>
/// Creates a new error response for a specific request with ERROR_INTERNAL status code.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <returns>Error response message that is ready to be sent.</returns>
public LocProtocolMessage CreateErrorInternalResponse(LocProtocolMessage Request)
{
return(CreateResponse(Request, Status.ErrorInternal));
}
/// <summary>
/// Creates a new error response for a specific request with ERROR_UNSUPPORTED status code.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <returns>Error response message that is ready to be sent.</returns>
public LocProtocolMessage CreateErrorUnsupportedResponse(LocProtocolMessage Request)
{
return(CreateResponse(Request, Status.ErrorUnsupported));
}
/// <summary>
/// Creates a new error response for a specific request with ERROR_PROTOCOL_VIOLATION status code.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <returns>Error response message that is ready to be sent.</returns>
public LocProtocolMessage CreateErrorProtocolViolationResponse(LocProtocolMessage Request)
{
return(CreateResponse(Request, Status.ErrorProtocolViolation));
}
/// <summary>
/// Creates a new successful response template for a specific request.
/// </summary>
/// <param name="Request">Request message for which the response is created.</param>
/// <returns>Response message template for the request.</returns>
public LocProtocolMessage CreateOkResponse(LocProtocolMessage Request)
{
return(CreateResponse(Request, Status.Ok));
}