Class SmppServer

Namespace

Inetlab.SMPP

Assembly

Inetlab.SMPP.dll

The SMPP server to which an SmppClient can be connected.

public sealed class SmppServer : IDisposable

Inheritance

object

SmppServer

Implements

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Constructors

SmppServer(IPEndPoint)

public SmppServer(IPEndPoint endPoint)

Parameters

endPoint IPEndPoint

Properties

ActualEndpoint

Gets the actual endpoint of the server after start.

public EndPoint ActualEndpoint { get; }

Property Value

EndPoint

ConnectedClients

Gets a list of connected clients

public IReadOnlyList<SmppServerClient> ConnectedClients { get; }

Property Value

IReadOnlyList<SmppServerClient>

ConnectionOptions

public SmppServerConnectionOptions ConnectionOptions { get; set; }

Property Value

SmppServerConnectionOptions

EnabledSslProtocols

Defines enabled versions of SSL Protocols for the SMPP client.

[Obsolete("Use ConnectionOptions.Ssl.EnabledSslProtocols instead.")]
public SslProtocols EnabledSslProtocols { get; set; }

Property Value

SslProtocols

Logger

public ILog Logger { get; set; }

Property Value

ILog

Name

Name of the server. Used for logging.

public string Name { get; set; }

Property Value

string

ServerCertificate

Gets or sets server certificate for SSL connection

[Obsolete("Use ConnectionOptions.ServerCertificate instead.")]
public X509Certificate ServerCertificate { get; set; }

Property Value

X509Certificate

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

RunAsync(CancellationToken)

Runs the SMPP server.

public Task RunAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The token to trigger server shutdown.

Returns

Task

Start()

Starts server asynchronously. Call Stop method to stop the server.

[Obsolete("Use StartAsync method instead.")]
public void Start()

Start(CancellationToken)

Starts server. Stops on cancellation token.

[Obsolete("Use RunAsync method instead.")]
public Task Start(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

StartAsync(CancellationToken)

Starts the server asynchronously.

public Task StartAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Indicates that the start process has been aborted.

Returns

Task

Stop()

Stop SMPP server

[Obsolete("Use StopAsync method instead.")]
public void Stop()

StopAsync()

Stops the server.

public Task StopAsync()

Returns

Task

Events

evClientBind

Occurs when SmppClient bind with server

public event ClientBindEventHandler evClientBind

Event Type

ClientBindEventHandler

evClientCancelSm

Occurs when SmppClient sent CANCEL_SM PDU

public event ClientCancelSmEventHandler evClientCancelSm

Event Type

ClientCancelSmEventHandler

evClientCertificateValidation

Validating client certificate.

[Obsolete("Use ConnectionOptions.Ssl.ValidateCertificate instead.")]
public event EventHandler<CertificateValidationEventArgs> evClientCertificateValidation

Event Type

EventHandler<CertificateValidationEventArgs>

evClientConnected

Occurs when SmppClient is connected

public event ClientConnectedEventHandler evClientConnected

Event Type

ClientConnectedEventHandler

evClientDataSm

Occurs when SmppClient sent DATA_SM PDU

public event ClientDataSmEventHandler evClientDataSm

Event Type

ClientDataSmEventHandler

evClientDisconnected

Occurs when SmppClient is disconnected

public event ClientDisconnectedEventHandler evClientDisconnected

Event Type

ClientDisconnectedEventHandler

evClientEnquireLink

Occurs when SmppClient sent ENQUIRE_LINK PDU

public event ClientEnquireLinkEventHandler evClientEnquireLink

Event Type

ClientEnquireLinkEventHandler

evClientOutBind

Occurs when MC initiate a SMPP session

public event ClientOutBindEventHandler evClientOutBind

Event Type

ClientOutBindEventHandler

evClientQuerySm

Occurs when SmppClient sent QUERY_SM PDU

public event ClientQuerySmEventHandler evClientQuerySm

Event Type

ClientQuerySmEventHandler

evClientReplaceSm

Occurs when SmppClient sent REPLACE_SM PDU

public event ClientReplaceSmEventHandler evClientReplaceSm

Event Type

ClientReplaceSmEventHandler

evClientSubmitMulti

Occurs when SmppClient sent SUBMIT_MULTI PDU

public event ClientSubmitMultiEventHandler evClientSubmitMulti

Event Type

ClientSubmitMultiEventHandler

evClientSubmitSm

Occurs when SmppClient sent SUBMIT_SM PDU

public event ClientSubmitSmEventHandler evClientSubmitSm

Event Type

ClientSubmitSmEventHandler

evClientUnBind

Occurs when SmppClient unbind from server

public event ClientUnBindEventHandler evClientUnBind

Event Type

ClientUnBindEventHandler

evServerStarted

Occurs when server is started

public event EventHandler evServerStarted

Event Type

EventHandler