PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PSSDP Class Reference

Simple Service Discovery Protocol. More...

#include <ssdp.h>

Inheritance diagram for PSSDP:
Collaboration diagram for PSSDP:

Public Types

enum  Commands { M_SEARCH = PHTTP::NumCommands, NOTIFY, NumCommands }
 
- Public Types inherited from PHTTP
enum  Commands {
  GET, HEAD, POST, PUT,
  DELETE, TRACE, OPTIONS, CONNECT,
  NumCommands
}
 
enum  StatusCode {
  BadResponse = 1, ContentProcessorError, UnknownTransferEncoding, TransportConnectError,
  TransportWriteError, TransportReadError, Continue = 100, SwitchingProtocols,
  RequestOK = 200, Created, Accepted, NonAuthoritativeInformation,
  NoContent, ResetContent, PartialContent, MultipleChoices = 300,
  MovedPermanently, MovedTemporarily, SeeOther, NotModified,
  UseProxy, BadRequest = 400, UnAuthorised, PaymentRequired,
  Forbidden, NotFound, MethodNotAllowed, NoneAcceptable,
  ProxyAuthenticationRequired, RequestTimeout, Conflict, Gone,
  LengthRequired, UnlessTrue, InternalServerError = 500, NotImplemented,
  BadGateway, ServiceUnavailable, GatewayTimeout
}
 
- Public Types inherited from PChannel
enum  PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }
 
enum  Errors {
  NoError, NotFound, FileExists, DiskFull,
  AccessDenied, DeviceInUse, BadParameter, NoMemory,
  NotOpen, Timeout, Interrupted, BufferTooSmall,
  Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors
}
 Normalised error codes. More...
 
enum  ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
 Error groups. More...
 
typedef PNotifierTemplate
< PChannel::AsyncContext & > 
AsyncNotifier
 
enum  ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }
 
- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 

Public Member Functions

 PSSDP ()
 Create a TCP/IP HTTP protocol channel. More...
 
bool Listen ()
 Listen for service notifications. More...
 
bool Search (const PString &urn, PMIMEInfo &reply)
 Search for device with the specified URN. More...
 
bool GetNotify (PMIMEInfo &mime, const PString &urnRegex=".*")
 Read a notification. More...
 
- Public Member Functions inherited from PInternetProtocol
virtual PBoolean Read (void *buf, PINDEX len)
 Low level read from the channel. More...
 
virtual int ReadChar ()
 Read a single 8 bit byte from the channel. More...
 
virtual PBoolean Write (const void *buf, PINDEX len)
 Low level write to the channel. More...
 
void SetReadLineTimeout (const PTimeInterval &t)
 Set the maximum timeout between characters within a line. More...
 
virtual PBoolean Connect (const PString &address, WORD port=0)
 Connect a socket to a remote host for the internet protocol. More...
 
virtual PBoolean Connect (const PString &address, const PString &service)
 
virtual PBoolean Accept (PSocket &listener)
 Accept a server socket to a remote host for the internet protocol. More...
 
const PStringGetDefaultService () const
 Get the default service name or port number to use in socket connections. More...
 
PIPSocketGetSocket () const
 Get the eventual socket for the series of indirect channels that may be between the current protocol and the actual I/O channel. More...
 
virtual PBoolean WriteLine (const PString &line)
 Write a string to the socket channel followed by a CR/LF pair. More...
 
virtual PBoolean ReadLine (PString &line, PBoolean allowContinuation=false)
 Read a string from the socket channel up to a CR/LF pair. More...
 
virtual void UnRead (int ch)
 Put back the characters into the data stream so that the next Read() function call will return them first. More...
 
virtual void UnRead (const PString &str)
 
virtual void UnRead (const void *buffer, PINDEX len)
 
virtual bool WriteCommand (PINDEX cmdNumber, const PString &param=PString::Empty())
 Write a single line for a command. More...
 
virtual bool WriteCommand (PINDEX cmdNumber, const PString &param, const PMIMEInfo &mime)
 
virtual PBoolean ReadCommand (PINDEX &num, PString &args)
 Read a single line of a command which ends with a CR/LF pair. More...
 
virtual PBoolean ReadCommand (PINDEX &num, PString &args, PMIMEInfo &mime)
 
virtual PBoolean WriteResponse (unsigned numericCode, const PString &info)
 Write a response code followed by a text string describing the response to a command. More...
 
virtual PBoolean WriteResponse (const PString &code, const PString &info)
 
virtual PBoolean ReadResponse ()
 Read a response code followed by a text string describing the response to a command. More...
 
virtual PBoolean ReadResponse (int &code, PString &info)
 
virtual PBoolean ReadResponse (int &code, PString &info, PMIMEInfo &mime)
 
virtual int ExecuteCommand (PINDEX cmdNumber)
 Write a command to the socket, using WriteCommand() and await a response using ReadResponse(). More...
 
virtual int ExecuteCommand (PINDEX cmdNumber, const PString &param)
 
int GetLastResponseCode () const
 Return the code associated with the last response received by the socket. More...
 
PString GetLastResponseInfo () const
 Return the last response received by the socket. More...
 
- Public Member Functions inherited from PIndirectChannel
 PIndirectChannel ()
 Create a new indirect channel without any channels to redirect to. More...
 
 ~PIndirectChannel ()
 Close the indirect channel, deleting read/write channels if desired. More...
 
Comparison Compare (const PObject &obj) const
 Determine if the two objects refer to the same indirect channel. More...
 
virtual PString GetName () const
 Get the name of the channel. More...
 
virtual P_INT_PTR GetHandle () const
 Get the OS specific handle for the PSoundChannel. More...
 
virtual PBoolean IsOpen () const
 Determine if the channel is currently open and read and write operations can be executed on it. More...
 
virtual PBoolean Shutdown (ShutdownValue option)
 Close one or both of the data streams associated with a channel. More...
 
virtual bool SetLocalEcho (bool localEcho)
 Set local echo mode. More...
 
virtual PChannelGetBaseReadChannel () const
 This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel. More...
 
virtual PChannelGetBaseWriteChannel () const
 This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of PIndirectChannel. More...
 
virtual bool CloseBaseReadChannel ()
 Close the base channel of channel indirection using PIndirectChannel. More...
 
virtual bool CloseBaseWriteChannel ()
 Close the base channel of channel indirection using PIndirectChannel. More...
 
virtual PString GetErrorText (ErrorGroup group=NumErrorGroups) const
 Get error message description. More...
 
PBoolean Open (PChannel &channel)
 Set the channel for both read and write operations. More...
 
PBoolean Open (PChannel *channel, PBoolean autoDelete=true)
 Set the channel for both read and write operations. More...
 
PBoolean Open (PChannel *readChannel, PChannel *writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
 Set the channel for both read and write operations. More...
 
PChannelDetach (ShutdownValue option=ShutdownReadAndWrite)
 Detach without closing the read/write channel. More...
 
PChannelGetReadChannel () const
 Get the channel used for read operations. More...
 
bool SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
 Set the channel for read operations. More...
 
PChannelGetWriteChannel () const
 Get the channel used for write operations. More...
 
PBoolean SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
 Set the channel for read operations. More...
 
template<class ChannelClass >
ChannelClass * FindChannel ()
 Locate a channel of a specific class in the indirect chain. More...
 
- Public Member Functions inherited from PChannel
PBoolean SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
 Set error values to those specified. More...
 
virtual PINDEX HashFunction () const
 Calculate a hash value for use in sets and dictionaries. More...
 
FILE * FDOpen (const char *mode)
 Re-open the device using the stdio library. More...
 
void SetReadTimeout (const PTimeInterval &time)
 Set the timeout for read operations. More...
 
PTimeInterval GetReadTimeout () const
 Get the timeout for read operations. More...
 
virtual PINDEX GetLastReadCount () const
 Get the number of bytes read by the last Read() call. More...
 
virtual PINDEX SetLastReadCount (PINDEX count)
 
PBoolean ReadBlock (void *buf, PINDEX len)
 Read len bytes into the buffer from the channel. More...
 
PString ReadString (PINDEX len)
 Read len character into a string from the channel. More...
 
void SetWriteTimeout (const PTimeInterval &time)
 Set the timeout for write operations to complete. More...
 
PTimeInterval GetWriteTimeout () const
 Get the timeout for write operations to complete. More...
 
virtual PBoolean Write (const void *buf, PINDEX len, const void *)
 Low level write to the channel with marker. More...
 
virtual PINDEX GetLastWriteCount () const
 Get the number of bytes written by the last Write() call. More...
 
virtual PINDEX SetLastWriteCount (PINDEX count)
 
PBoolean WriteChar (int c)
 Write a single character to the channel. More...
 
PBoolean WriteString (const PString &str)
 Write a string to the channel. More...
 
 ~PChannel ()
 Close down the channel. More...
 
Errors GetErrorCode (ErrorGroup group=NumErrorGroups) const
 Get normalised error code. More...
 
int GetErrorNumber (ErrorGroup group=NumErrorGroups) const
 Get OS errro code. More...
 
virtual bool ReadAsync (AsyncContext &context)
 Begin an asynchronous read from channel. More...
 
virtual void OnReadComplete (AsyncContext &context)
 User callback function for when a ReadAsync() call has completed or timed out. More...
 
virtual bool WriteAsync (AsyncContext &context)
 Begin an asynchronous write from channel. More...
 
virtual void OnWriteComplete (AsyncContext &context)
 User callback function for when a WriteAsync() call has completed or timed out. More...
 
virtual bool FlowControl (const void *flowData)
 Flow Control information Pass data to the channel for flowControl determination. More...
 
PBoolean SetBufferSize (PINDEX newSize)
 Set the iostream buffer size for reads and writes. More...
 
PBoolean SendCommandString (const PString &command)
 Send a command meta-string. More...
 
void AbortCommandString ()
 Abort a command string that is in progress. More...
 
- Public Member Functions inherited from PObject
__inline unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
__inline void SetTraceContextIdentifier (unsigned id)
 
__inline void SetTraceContextIdentifier (const PObject &obj)
 
__inline void SetTraceContextIdentifier (const PObject *obj)
 
__inline void CopyTraceContextIdentifier (PObject &obj) const
 
__inline void CopyTraceContextIdentifier (PObject *obj) const
 
virtual ~PObject ()
 
__inline const char * GetClass () const
 
__inline bool IsClass (const char *name) const
 
__inline const PObjectPTraceObjectInstance () const
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Static Public Member Functions

static const PCaselessStringMXTag ()
 
static const PCaselessStringSTTag ()
 
static const PCaselessStringMANTag ()
 
static const PCaselessStringUSNTag ()
 
static const PCaselessStringNickNameTag ()
 
- Static Public Member Functions inherited from PHTTP
static const PCaselessStringHostTag ()
 
static const PCaselessStringAllowTag ()
 
static const PCaselessStringAuthorizationTag ()
 
static const PCaselessStringContentEncodingTag ()
 
static const PCaselessStringContentLengthTag ()
 
static const PCaselessStringContentTypeTag ()
 
static const PCaselessStringDateTag ()
 
static const PCaselessStringExpiresTag ()
 
static const PCaselessStringFromTag ()
 
static const PCaselessStringIfModifiedSinceTag ()
 
static const PCaselessStringLastModifiedTag ()
 
static const PCaselessStringLocationTag ()
 
static const PCaselessStringPragmaTag ()
 
static const PCaselessStringPragmaNoCacheTag ()
 
static const PCaselessStringRefererTag ()
 
static const PCaselessStringServerTag ()
 
static const PCaselessStringUserAgentTag ()
 
static const PCaselessStringWWWAuthenticateTag ()
 
static const PCaselessStringMIMEVersionTag ()
 
static const PCaselessStringConnectionTag ()
 
static const PCaselessStringKeepAliveTag ()
 
static const PCaselessStringUpgradeTag ()
 
static const PCaselessStringWebSocketTag ()
 
static const PCaselessStringWebSocketKeyTag ()
 
static const PCaselessStringWebSocketAcceptTag ()
 
static const PCaselessStringWebSocketProtocolTag ()
 
static const PCaselessStringWebSocketVersionTag ()
 
static const PCaselessStringTransferEncodingTag ()
 
static const PCaselessStringChunkedTag ()
 
static const PCaselessStringProxyConnectionTag ()
 
static const PCaselessStringProxyAuthorizationTag ()
 
static const PCaselessStringProxyAuthenticateTag ()
 
static const PCaselessStringForwardedTag ()
 
static const PCaselessStringSetCookieTag ()
 
static const PCaselessStringCookieTag ()
 
static const PCaselessStringFormUrlEncoded ()
 
- Static Public Member Functions inherited from PChannel
static PString GetErrorText (Errors lastError, int osError=0)
 Get error message description. More...
 
- Static Public Member Functions inherited from PObject
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject *from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject *from)
 
static __inline const char * Class ()
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
template<typename T >
static Comparison Compare2 (T v1, T v2)
 Compare two types, returning Comparison type. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 

Protected Member Functions

bool Close ()
 Close the channel. More...
 
- Protected Member Functions inherited from PHTTP
 PHTTP ()
 Create a TCP/IP HTTP protocol channel. More...
 
 PHTTP (const char *defaultServiceName)
 
virtual PINDEX ParseResponse (const PString &line)
 Parse a response line string into a response code and any extra info on the line. More...
 
- Protected Member Functions inherited from PInternetProtocol
 PInternetProtocol (const char *defaultServiceName, PINDEX cmdCount, char const *const *cmdNames)
 
bool SetLastResponse (int code, const PString &info, ErrorGroup group=LastGeneralError)
 
- Protected Member Functions inherited from PIndirectChannel
virtual PBoolean OnOpen ()
 This callback is executed when the Open() function is called with open channels. More...
 
 PDECLARE_READ_WRITE_MUTEX (channelPointerMutex)
 Race condition prevention on closing channel. More...
 
- Protected Member Functions inherited from PChannel
 PChannel (const PChannel &)
 
PChanneloperator= (const PChannel &)
 
virtual PBoolean ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
 Convert an operating system error into platform independent error. More...
 
int ReadCharWithTimeout (PTimeInterval &timeout)
 Read a character with specified timeout. More...
 
PBoolean ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)
 
bool CheckNotOpen ()
 
virtual int os_errno () const
 
PBoolean PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
 
P_INT_PTR GetOSHandleAsInt () const
 
int PXClose ()
 
 PDECLARE_MUTEX (px_threadMutex)
 
 PDECLARE_MUTEX (px_writeMutex)
 
 PChannel ()
 Create the channel. More...
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 

Protected Attributes

bool m_listening
 
- Protected Attributes inherited from PInternetProtocol
PString defaultServiceName
 
PStringArray commandNames
 
PCharArray unReadBuffer
 
PINDEX unReadCount
 
PTimeInterval readLineTimeout
 
enum PInternetProtocol::StuffState stuffingState
 
PBoolean newLineToCRLF
 
int m_lastResponseCode
 
PString m_lastResponseInfo
 
- Protected Attributes inherited from PIndirectChannel
PChannelreadChannel
 Channel for read operations. More...
 
PBoolean readAutoDelete
 Automatically delete read channel on destruction. More...
 
PChannelwriteChannel
 Channel for write operations. More...
 
PBoolean writeAutoDelete
 Automatically delete write channel on destruction. More...
 
- Protected Attributes inherited from PChannel
PTimeInterval readTimeout
 Timeout for read operations. More...
 
PTimeInterval writeTimeout
 Timeout for write operations. More...
 
atomic< P_INT_PTRos_handle
 The operating system file handle return by standard open() function. More...
 
PThreadLocalStorage< Statusm_status [NumErrorGroups+1]
 
PXBlockType px_lastBlockType
 
PThreadpx_readThread
 
PThreadpx_writeThread
 
PThreadpx_selectThread [3]
 
PCriticalSection px_selectMutex [3]
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Additional Inherited Members

- Protected Types inherited from PInternetProtocol
enum  StuffState {
  DontStuff, StuffIdle, StuffCR, StuffCRLF,
  StuffCRLFdot, StuffCRLFdotCR
}
 

Detailed Description

Simple Service Discovery Protocol.

Member Enumeration Documentation

Enumerator
M_SEARCH 
NOTIFY 
NumCommands 

Constructor & Destructor Documentation

PSSDP::PSSDP ( )

Create a TCP/IP HTTP protocol channel.

Member Function Documentation

bool PSSDP::Close ( )
protectedvirtual

Close the channel.

This will detach itself from the read and write channels and delete both of them if they are auto delete.

Returns
true if the channel is closed.

Reimplemented from PIndirectChannel.

bool PSSDP::GetNotify ( PMIMEInfo mime,
const PString urnRegex = ".*" 
)

Read a notification.

bool PSSDP::Listen ( )

Listen for service notifications.

static const PCaselessString& PSSDP::MANTag ( )
static
static const PCaselessString& PSSDP::MXTag ( )
static
static const PCaselessString& PSSDP::NickNameTag ( )
static
bool PSSDP::Search ( const PString urn,
PMIMEInfo reply 
)

Search for device with the specified URN.

Note that the Listen() must not have been called for this function to work correctly.

Parameters
urnResource identfier to search for
replyMIME for the reply
static const PCaselessString& PSSDP::STTag ( )
static
static const PCaselessString& PSSDP::USNTag ( )
static

Member Data Documentation

bool PSSDP::m_listening
protected

The documentation for this class was generated from the following file: